Changelog

0.18.3 (Beta 18)

🐛 Bug Fixes

Improves types for button and submit inputs (#895).
Improves types for multi-step plugin

0.18.2 (Beta 18)

🐛 Bug Fixes

Fixes a bug that caused the ledger to perform incorrect unmerge calculations for counters that were not the first in the set. This caused groups and lists to occasionally leave their counter values behind when unmounted (#878).

0.18.1 (Beta 18)

🐛 Bug Fixes

Fixes a bug that caused forms with dynamic lists to throw errors when being reset (#731).
Fixes a bug that caused schema data to render improperly in some edge cases when the schema was being updated dynamically (#610).
Fixes the autoHeightTextareaPlugin and greatly improves it’s resizing accuracy (#888)
Fixes tet and lt translations (#886)

0.18.0 (Beta 18)

🎉 Keynote features

Improved TypeScript Support 🎉

1 min

Enhanced TypeScript prop support for Vue 3.3+. #627
New barcode input available via @formkit/barcode package. Barcode docs

💪 New features

Introduced dropdown input functionalities:
- Support for removing the current selection. #646
- Multi-select capability. #647
The whenAvailable utility from @formkit/utils dynamically references its document context, facilitating FormKit's usage within web component shadow DOM. #837
New behavioral properties for dropdown, autocomplete, and taglist inputs.
Added an #empty section/slot for the repeater input to display context when there are no values. Repeater docs
Adds Lithuanian 🇱🇹 (lt)

🐛 Bug fixes

The repeater respects the disabled state of its parent form. #579
The taglist accepts empty options. #586
Prevented unnecessary calls to options method in dropdown family inputs. #657
Ensured autocomplete input compatibility with Vue's @focus directive. #670
The taglist accepts values outside its options list. #681
Resolved field reactivation after parent form reenabling. #733
Addressed datepicker error on keyboard navigation in picker-only mode. #736
Corrected checkbox label slot overwrite by adjacent radio. #778
Genesis theme limits pointer-events: none to submit-type buttons in the actions slot. #790
"Compare" dirty checks adapt to new values provided during form reset. #791
Ensured taglist respects the max prop with open-on-click enabled. #793
Enhanced autocomplete with selectionAppearance set to option to work with open-on-click prop. #817
Fixed issues with the eq function from @formkit/utils. #819
Resolved datepicker navigation error when starting with year. #827
Ensured taglist respects the max prop with close-on-select disabled. #838
Addressed inline array-syntax validation prop exceptions. #852
Fixed FormKit CLI export path issues. #854
Resolved schema compiler issues with FormKit. #857
The formkit-icon class aligns with config.rootClasses. #859
Remedied Transfer List drag-and-drop glitches. #863
Addressed a datepicker Safari focus issue by modifying the open button to a role="button" div. #864
Dropdown inputs (dropdown, autocomplete, taglist) can now render values that are not part of their options list. #877

0.17.5 (Beta 17)

💪 New features

Adds new <FormKitRoot> component. This component provides context about the root element (Document or ShadowRoot). When using FormKit inside a Custom Element (Web Component) wrap one or many FormKit input’s in <FormKitRoot> to ensure proper functionality.
Adds new node.props.__root and context.__root property that references the node’s current root element (Document | ShadowRoot).

🐛 Bug fixes

Fixes an issue where the mult-step input plugin would break when rendering steps in a v-for loop or conditionally rendering a step via schema. #823 #825
Textarea Auto-height plugin recalculates height when programmatically changing the value. #839
Fixes an issue in Zod plugin that prevents transforms from being applied. #833

0.17.4 (Beta 17)

💪 New features

Adds new data-empty attribute to input outer wrappers for styling purposes. #777
Updates to Nuxt module allowing for runtimeConfig support — see the new docs in the installation wizard guide. #795

🐛 Bug fixes:

Actually really for real fixes issue where blur event could cause console errors on route change. #776
Fixes issue where null icon value would throw error. #780
Fixes missing semicolon in multistep.css. #783
Fixes use of :model-value prop not updating internal FormKit node values. #785

0.17.3 (Beta 17)

💪 New features

Adds 🇲🇳 Mongolian (mn) language - #747
Adds 🇮🇸 Icelandic (is) language #748
Adds new node.next(), node.previous(), and node.goTo() extensions for multi-step inputs via MultiStep plugin. This allows for easier external control of multi-step input navigation. #685
Adds new node.restoreCache() extension for the localStorage plugin to allow restoring of form values to cache on failed submit. #727

🐛 Bug fixes:

Fixes SSR hydration issues for the multi-step input. #720
Fixes issue where blur event could cause console errors on route change. #735
Fixes issue where Pro inputs would break when used with the Floating Labels plugin. #742
MultiStep beforeStepChange now works with async function calls. #743
Fixes issue where file inputs would not allow re-uploading the same file after calling reset. #762
Prevents Genesis CSS keyframe naming conflict by adding fk- prefix.

0.17.2 (Beta 17)

🐛 Bug fixes:

Fixes an issue that caused deeply nested v-model’s to not update when a mutation originated at depth (#722)
Fixes an issue that caused custom inputs that overrode the text family of inputs to re-use the first schema(#719)
Exports type FormKitValidationMessage to help type validation message functions (#695)

💪 New features

localStorage plugin now supports new options: key, control, debounce, beforeSave, and beforeLoad.
localStorage plugin can now be applied to any input of internal type group. eg (form, group, multi-step, etc).

0.17.1 (Beta 17)

🐛 Bug fixes

Fixed a bug that caused and error to be thrown when a dynamic list was initialized with identical initial scalar values (#715)
Fixed a bug that caused the value property of a slot to not be updated in some edge cases (#717).

0.17.0 (Beta 17)

May 12, 2023

💪 New features

New FormKit Zod plugin — Validate your FormKit forms using Zod schema.
New dynamic list prop allows you to easily create your own repeaters.
New Save to localStorage plugin for saving user progress in forms and protecting against lost data in the event of an unexpected event.
Adds new validation rules: require_one (thanks @devoidofgenius), contains_alpha, contains_alphanumeric, contains_alpha_space, contains_symbol, contains_uppercase, contains_lowercase, contains_numeric, symbol, uppercase, and lowercase (thanks @riderx).
New Auto-height textarea plugin to create textarea inputs with dynamically resizing height.
Pro: New Slider input.
Adds new commitRaw event that fires even if there is no change to the input value.
FormKitSchema can now use a single root node (instead of a fragment)
All FormKit inputs now use a root node instead of a fragment meaning standard Vue directives like v-show now work adding a key to dynamic inputs is generally no longer required (#528).
The AutoAnimate plugin now supports animating the repeater input and other Pro inputs.
Values passed into the node.reset() function become the new default value for the input (#621).
Adds traditional Chinese 🇨🇳 (zh-TW)
Adds Latvian 🇱🇻 (lv)
Adds Tetum 🇹🇱 (tet)
Adds new ability to extend a core node with node.extend().

⚡️ Performance

Dramatically improved the performance of mounting inputs in a large form (5-10x faster).
Improved performance of hydrating a form by diffing scalar values before inputting.
Reduced the noise on the @input event and removed the now unnecessary debounce on the change event.

🐛 Bugfixes

The @formkit/observer will now observe changes to node._value in instances where you want to operate on the non-debounced input value.
The range icon in @formkit/icons has been updated to only show one control handle since HTML range inputs do not support multiple values. The old multi-handle icon has been repurposed for the new slider FormKit Pro input.
Pro: Fixes a bug that caused nested repeater inputs to not hydrate properly (#458).
Pro: Fixes a bug that caused nested repeater inputs to throw an error when being removed (#457).
Fixes a bug that caused the blur event to fire multiple times when manually binding to the @blur event on a custom input (#413).
Fixes a bug that caused v-model to only fire input events on every other input (#463)
Fixes a bug that caused the schema to iterate over the value of an array if the array had a length of 1 and the only value in the array was a number (#635)
Fixes an issue that caused node.walk() to prematurely end when using stopOnFalse.
Fixes memory leak in SPA browsing and SSR environments (#475)

Beta 16 is the first version of FormKit that does not have a pre-release identifier. Beta 16 and all remaining beta versions will be released under the 0.x.x semantic version. The first stable release will be 1.0.0 and is targeted for later this year. This change in versioning should help with package manager dependency resolution as we complete our beta release cycles.

💪 New features

Pro: New Transfer List input! A great option for helping your users select information from a large set of data.
Pro: The floating labels plugin now supports FormKit Pro Inputs.
Pro: The mask input now supports multiple colors by providing an overlay option.
Adds a new dirty-behavior prop allows users to opt into a compare behavior which compares the current value of the input to the original value of the input. If the input is changed back to its original state the context.state.dirty flag will revert back to false.
Adds i18n translations for some new ui and validation rules.

🐛 Bugfixes

The options prop (used in select, radio, checkboxes and some pro inputs) can now differentiate between null and undefined values.
Fixes issues with the @formkit/nuxt module and syntax highlighting.
Fixes a bug that caused the dirty state of an unrelated input to get incorrectly set true when an object (like a group) was updated (#520).
The floating labels plugin now hides placeholders until focused (#574).
Fixes a bug that caused forms to not receive the submitted state like the form’s children on an unsuccessful form submission (#503).
The multi-step input now preserves step order when conditionally rendering steps (#613).
Fixes a tailwind styling bug for checkboxes and radios (#584).

1.0.0-beta.15

February 6, 2023

This release adds new 1st-party plugins to the @formkit/addons package, ships bug fixes and styling updates for both CSS and Tailwind CSS users.

💪 New features

Easily create multi-step forms or include multi-step sections inside your forms with the new multi-step plugin in @formkit/addons. Ships with standalone CSS styling you can import that works well with our genesis theme. Check out the full documentation here.
Enable floating labels for all text family (text, email, url, etc) and textarea inputs with the new floating labels plugin in @formkit/addons. Check out the full documentation here.
Adds new Next and Previous strings to UI localization object for use in plugins and custom inputs.

🐛 Bug fixes

Fixes missing Tailwind CSS genesis theme export path in @formkit/themes.
Adds :focus-visible styling to buttons to show focus state when using keyboard navigation.
Adds missing loading styles for submit buttons in the Tailwind CSS Genesis theme.

📘 Articles

New Article: Create a Multi-Step form in Vue in 5 Minutes

Reverts @formkit/themes/tailwindcss to only include a default export of the FormKitVariants plugin.
Moves the provided Tailwind Genesis theme to a new export path of @formkit/themes/dist/tailwindcss/genesis.
Changes remove class operator from ! to $remove: in order to not conflict with Tailwind's built-in ! operator that adds !important to a style rule.
Fixes issue where default icons would not load when using the provided FormKit Tailwind Genesis theme.

Adds new <FormKitMessages> component which allows relocation of a form’s validation and error messages and the ability for group and list inputs to display their own error and validation messages.
When removing classes on a section of a FormKit input you can use the ! prefix operator to selectively remove an existing class without needing to use the long-form object syntax. eg outer-class="my-class !formkit-outer" adds my-class and removes the default formkit-outer class.
Adds Catalan (thanks @petergithubmgw).
The checkbox and radio inputs now have a data-checked attribute around their respective wrapper making it easy to add custom styling for checked vs non-checked states.
Improves validation messages in a handful of languages (en, pt, zh).
Pro: New Mask Pro input.
Pro: Adds empty-message prop allows for message to be rendered in listbox when no options are passed (dropdown, autocomplete, and taglist). #502
Pro: Adds checked attribute to formkit-option (dropdown, autocomplete, taglist). #350
Pro: Adds max prop for taglist and autocomplete with multiple inputs. #501
Pro: Adds closeOnSelect prop will keep the listbox expanded as selections are made (autocomplete multiple and taglist).
Pro: Adds forceExpanded prop forces the listbox to remain open for dev purposes (dropdown, autocomplete, and taglist).
Pro: All Pro inputs can now be disabled via disabled attribute.

🐛 Bug fixes

Fixed a bug where date_after rule showed a incorrect validation message because of timezones. #488
Fixed a bug where self-generated ids did not have an attribute-safe value because of special characters. #517
v-model values can now be initialized as undefined. #235
Fixed a bug that caused inline validation-rules props to recurse unexpectedly. #514
Fixed a bug that caused the label of checkboxes with multiple options to not be overridden with sections-schema. #541
Fixed a bug that caused labels to not change dynamically in already-rendered validation messages. #297
Fixed a bug that caused the disabled prop to need null instead of false to render the data-disabled attribute on the outer wrapper. #511
Fixed a bug that prevented slots from being conditional (ie using v-if on the <template v-slot> block). #489
Fixed Nuxt and Nuxt playground compatibility issues.
Fixed a bug that caused sections using to not properly respect sections-schema prop.
Fixed an issue with Tailwind prefix and suffix icon variants. #530
Pro: Fixed a taglist bug where duplicate options were loaded from API. #497
Pro: Fixed a bug where the taglist would render duplicate props when multiple prop set to false. #494
Pro: Fixed a bug where autocomplete options were duplicating when being used fast, repeatedly, or with pasted content. #431
Pro: Fixed issue where default value for autocomplete and taglist could not be removed when the provided value was an object literal. #505
Pro: Fixed an issue where the listbox was still visible when no options were passed. #504

📙 Documentation & Playground

New API Reference — TypeScript users rejoice! The API Reference exposes previously undocumented functionality.
New Tailwind implementation of our Genesis theme.
When choosing Tailwind CSS in the FormKit Playground the new FormKit Tailwind Genesis theme is loaded automatically for you if your Playground does not already have a formkit.config.js file.

Pro: New Taglist Pro Input now available!
Adds npx formkit create-app command to easily bootstrap new FormKit projects.
Improves length rule validation messages across all languages.
Adds 🇬🇷 Greek (uk) language #460.
Adds 🇳🇴 Norwegian Bokmål (nb) language #418.
Adds 🇸🇰 Slovak (sk) language #401.
Pro: All Pro Inputs can now be disabled.
Pro: Improvements to Genesis Pro theme.
Pro: Autocompletes with multiple options selected can now be re-ordered via drag & drop.
Pro: Added missing attrs to the message schema.

🐛 Bug fixes

Fixed a bug where the label slot didn't work without the label prop #456.
Fixed a bug where you couldn't dynamically change available validation rules #449.
Fixed a bug where swapping keys would not clear an input's value when inside a group. #446.
Fixed a bug where Date object methods were inaccessible from Schema #406.
Fixed a pathing issue that made it difficult for third-parties from accessing files #404.
Fixed a bug that prevented the stopIfFalse argument on the walkTree function.
Fixed a bug where a select input initialized with a null value doesn't have a good value #415.
Pro: Fixed a bug count:blocking event was not emitting properly in Repeaters.
Pro: Updated Repeater indexes to be numbers instead of strings. #422.
Pro: Fixed an autocomplete bug where the next page of options was overriding the current page. #447.
Pro: Fixed a bug where Pro inputs were not showing validation messages on blur #403.

Lays foundation for FormKit Pro Inputs!

🐛 Bug fixes

Fixed a bug where the "help" slot appeared twice for checkbox and radio elements #353.
Fixed a bug that caused the FormKit AutoAnimate plugin to fail with Nuxt #361.
Fixed a schema bug where a dot-notation reference to a non-existing sub property causes [Object object] to output after the reference does exists #368.
FormKit now works with Nuxt 3.0.0-rc.8 and 3.0.0-rc.9 #371 and #383.
Fixed a bug where users were unable to use hooks via plugin to update v-modeled values #391.
Fixed a bug where users were unable to import @formkit/themes/tailwindcss with TypeScript #376.
Fixed a bug that caused default icons to never load when included directly in the configuration.
Fixed a bug where a checkbox validation with "required" worked only the first time #169.

Input definitions now have an optional family property, which adds a data-family attribute, and sets the value on node.props.family. This is useful for applying plugins and styles to entire "families" of inputs like the text family of inputs, which would apply to text, email, password, number, etc.
Input definitions now include an optional forceTypeProp property which ensures the node.props.type is initialized as a given value even if the input is registered under a different name. For example myModifiedCheckbox could still have node.props.type report "checkbox".
Adds data-multiple attribute to checkboxes and radios when they have multiple options.
Adds new @submit-invalid event to type="form" inputs. The event is triggered when a user attempts to submit a form but it has invalid inputs.
Adds new getValidationMessages helper function to @formkit/validation that extracts a Map of nodes and their validation messages.
Adds new decorator-icon section to checkboxes and radios, making it easy to use custom SVGs in your checkboxes and radios.
Adds new "check" and "circle" icons to the built in icon pack.
Adds 🇦🇿 Azerbaijani (az) language.
Adds 🇺🇦 Ukrainian (uk) language.

🐛 Bug fixes

Fixed a regression where a single checkbox was no longer displaying the help text (#310).
Fixed a bug that caused the AutoAnimate plugin to fail on Nuxt SSR (#330).
Fixed a bug that caused all input’s context.state.dirty to turn true when a v-modeled form was edited (#311).
Fixed a bug that caused a race condition between the @change event of a select list and the v-model value propagation (#335).
Fixed a bug that caused conditional props/attrs that returned arrays to return objects instead of arrays (#317).
Fixed a bug that caused empty file inputs to be set to undefined instead of an empty array when node.reset() is called (#319).
Fixed a bug that caused the disabled prop to improperly disable checkboxes and radio inputs when set to a falsy (not nullish) value (#307).

The file input’s removeFiles section has been renamed to fileRemove.
The fileRemove (previously removeFiles) section used to rendered an <a> tag, this has been changed to a button.
Composables from @formkit/inputs have been replaced with "sections". This should only affect users who were creating their own inputs from pre-existing composables.

🎉 New features

Icons! FormKit now ships with first class support for icons, including a first-party MIT licensed icon pack with automatic CDN delivery. Read more about it on the new icons documentation page.
AutoAnimate! FormKit now includes an AutoAnimate plugin, bringing AutoAnimate support to FormKit with a single line of code.
Exports! You can now export any of the existing inputs and restructure them at will using the new @formkit/cli command line tool. Alter existing inputs by adding, removing, updating, or re-ordering sections — or add your own exported and altered input variations to your input library.
All inputs have been refactored to use a much improved schema composition API that allows easy composition and modification of schema based inputs.
Adds new meta property to schema specification (#248).
FormKit CSS themes can be installed via CDN using the new theme option in defaultConfig()
Adds new submit and setErrors hooks.
Adds 🇧🇬 Bulgarian language.
Adds 🇭🇺 Hungarian language.
Adds 🇰🇿 Kazakh language.
Adds 🇷🇸 Serbian language.
Adds 🇹🇯 Tajik language.

🐛 Bug fixes

Fixed a bug that caused the key property to not work when using the $formkit shorthand in schema (#232).
Fixed a bug that did not call event handlers on @blur (#239).
Fixed a bug that caused 1 too many for iterations on old Safari browsers (#299).
Added automatic keys to FormKit inputs which fixed a smattering reactivity bugs when explicit keys were not used with conditional inputs.
The input-errors prop will now reset any errors it previously set when set to an empty object {} (#277).
Adds support for Czech/Slovak diacritics in alpha and alpha_spaces rules (#281).

📙 Documentation

New docs page for FormKit Icons 🎉.
New guide for exporting and restructuring icons!
New docs using the AutoAnimate plugin.
Input diagrams include new icon sections.

The tailwindcss, unocss, and windicss plugins must now be imported from their own subpath of the @formkit/themes package. For example:

import formKitTailwindPlugin from '@formkit/themes/tailwindcss'

🐛 Bug fixes

Removes improper imports from windicss, tailwindcss and unocss.

The update:model-value event will now only be emitted when using the v-model directive.
The input event is now debounced to reduce the amount of noise being emitted. You can use the new input-raw to listen to every input event.
Errors set via setErrors are now automatically cleared on input by default. To revert to the previous behavior, set preserveErrors: true in your global config object.
The @formkit/tailwindcss package is now deprecated — both the formKitTailwind plugin and the generateClasses function have been moved to the @formkit/themes package.

🎉 New features

checkbox, radio, and select inputs (inputs that use :options) can now use any data type as their value like numbers, objects, or even null (#85).
Adds new node.clearErrors and clearErrors utilities to assist in clearing backend errors from an input or form.
Now inputs automatically clear any errors set with node.setErrors() on user input. You can override this default behavior (to keep the error on the input) with preserve-errors="true".
Adds a new node.addProps function for adding new props in custom plugins.
Adds new message hook for modifying messages as they are being set.
Adds a new core event reset — emitted after a form is reset.
Adds a new index prop that allows inputs to be injected at a given index on a parent list type.
The <FormKit> component’s input event is now debounced, meaning it emits much less noise.
Exports all input feature functions import { features } from '@formkit/inputs'.
Adds a new input-raw event to the <FormKit> component which is emitted for every single input event in an input, list, group, or form (very noisy).
The core node is now the second argument of the input, input-raw, submit and submit-raw events.
Adds new core node event dom-input-event which has the native HTML Event object as the payload.
@formkit/themes now includes named exports for plugin functions for Tailwind CSS (formKitTailwind), Windi CSS (formKitWindi), and Uno CSS (formKitUno). By adding the correct plugin to your CSS framework's configuration file you will have access to a variety of formkit variants such as formkit-invalid: and formkit-disabled:.
@formkit/themes now includes the generateClasses helper function will allows you to easily supply different class lists to ${sectionKey}s based on input type.
Adds 🇸🇪 Swedish language.
Adds 🇸🇮 Slovenian language.
Adds 🇷🇴 Romanian language.
Adds 🇯🇵 Japanese language.
Adds 🇹🇭 Thai language.
Improves 🇵🇱 Polish language.

🐛 Bug fixes

🔥 Dramatically improves v-model performance and reliability for deeply nested structures like forms with list and groups.
Fixes an issue that caused null values to throw errors (#151)
Fixed a bug that caused validation-visibility to not change when updated reactively (#159)
Fixes a bug that caused the preserve keyword to block some form submissions (#145)
Fixes TypeScript typing for the @formkit/tailwind configuration (#143)
Fixes a bug that caused single checkboxes with an object as the on-value to not be set their initial value when using the :value prop.
Fixes a bug that caused validation rules to not be updated when the label prop changed (#170)
Fixes a bug that caused incorrect default selection on select lists with an explicit multiple="false" attribute and a placeholder (#148).
Fixes a bug that caused the classes prop to not react to Vue’s reactivity when using nested refs (#155).
Fixes a bug that prevented submit buttons from being disabled when applied using using the disabled attribute on the form without specifying disabled="true" (#215)
Fixes a schema compiler bug that caused the white space of a quoted string in a parenthesis to be incorrectly removed (#150).

Adds new alpha_spaces validation rule (#83)
Adds 🇨🇿 Czech (thanks @dfridrich)
Adds Frisian (thanks @arjendejong12)

📙 Documentation

New configuration documentation that explains the relationship of node options, config, and props.

🐛 Bug fixes

Fixes a bug that caused radio inputs to loose reactivity when set via node.input() (#139)
Improves TypeScript annotation for @submit event (#130)
Fixed an issue that caused selects not to render if set to an empty array (#129)
Fixed an error that caused server side rendering errors on Nuxt 3 when running a built project (#113)
Fixed a bug that caused schema variable scoping to be lost when referencing iteration data inside the slot of a component (#91)

The data-loading attribute has been moved from the submit button of a form to the <form> tag itself.

🎉 New features

Adds new @formkit/tailwindcss plugin to easily create Tailwind themes for your FormKit forms. Check out the Create a Tailwind CSS theme guide for more details.
Adds a new programmatic reset function. This can be done on any input, group, form, or list and it will restore the value back to its initial state. It also resets the context.state object (like blurred and dirty).
Improves accessibility by adding aria-describedby and aria-live to all provided input types. aria-describedby now targets help text, validation messages, and error messages (labeling provided by <label> tags that use the for attribute).
Groups, lists and forms can now apply undefined values to their children. In other words, if a form is v-modeled and its value is set to an empty object {}, it will clear the entire form out.
Adds new context.state.settled property that signals when the input’s internal debounce cycle has ended and a value is finished being committed to the form.
Adds data-submitted attribute to inputs that have been submitted.
Adds new section key fileName (thanks @santi).
Adds new parent prop that accepts a core node for advanced use cases where inputs are decoupled from their form or data structure is desired.
Adds 🇱🇾 Arabic (thanks @Ahmedelforjani)
Adds 🇩🇰 Danish (thanks @bjerggaard)
Adds 🇮🇩 Indonesian (thanks @rama-adi)
Adds 🇮🇹 Italian (thanks @punga78, @Archetipo95)
Adds 🇵🇱 Polish (thanks @xxSkyy)
Adds 🇰🇷 Korean (thanks @bwp618)
Adds 🇻🇳 Vietnamese (thanks @oanhnn)
Improved 🇫🇷 French (thanks @pop123123123)

🐛 Bug fixes

Fixes a bug that could cause validation errors to flash for 20ms before resolving when using browser autocomplete (#99).
Fixes a bug that caused class props (like input-class) inside schemas to not properly respect the $reset command because it was treated like a variable (#61).
Fixes a bug that didn't allow classes to be modified via section-key class props when the section-key has multiple words, such as file-list-class or file-item-class (#120).

The genesis theme should now be imported from import '@formkit/themes/genesis.

🎉 New features

Adds programmatic form submission:
- Can be submitted by node node.submit() (including any child node of the form).
- Can be submitted via function this.$formkit.submit('form-id') (for composition api it's submitForm('form-id')).
Improved setErrors DX:
- Can now be called directly on a node node.setErrors(nodeErrors, childErrors).
- setErrors now supports pure string node.setErrors('My error')
Submit handler is now passed the form’s node for easy error setting.
A <FormKit> component’s core node is now available via template ref.
Adds data-invalid attribute to the outer section when an input has failing validation messages that are currently displayed (playground example).
Adds data-errors attribute to the outer section when the input has explicitly placed errors (via prop or setErrors).
Adds data-complete attribute to the outer section when an input (playground example):
- Either:
  - The input has validation rules.
  - The validation rules are all passing.
  - There are no errors on the input.
- Or:
  - The input has no validation rules.
  - The input has no errors.
  - The input is dirty and has a value.
New context.state properties:
- state.rules - true when the input has validation rules.
- state.errors - true when the input has explicit errors placed on it.
- state.complete - same as logic as data-complete.
- state.validationVisible - true when the validation-visibility condition is met (it is showing validation errors if there are any).
Refactors the Nuxt 3 module for faster build time and better file resolution.
Adds 🇮🇷 Persian language support (thanks @shahabbasian)
Adds 🇧🇷 Portuguese language support (thanks @r-martins)
Adds 🇹🇷 Turkish language support (thanks @ragokan)
Adds 🇫🇮 Finish language support (thanks @mihqusta)
Adds 🇦🇷 Spanish language support (thanks @inibg)

📙 Documentation

Added node.setErrors documentation.
Added programmatic form submission documentation.
Improved context.state documentation with new properties and better descriptions.

🐛 Bug fixes

Fixes an issue that caused server side rendering and server side generation on Nuxt and vite-ssg/vitesse to throw exceptions during build process (#81).
Fixes a bug that prevented file inputs from triggering custom onChange events (#90).
Fixes a bug that prevented forms from outputting their id to the DOM.
Fixes a styling issue in the Genesis theme that caused select list items to be grey before an option was selected when using a placeholder (#59)
Fixes a bug that caused the :value prop on forms to be mutated on input (#72).
Fixes inconsistency between prop:{propName} events emitted by default props and custom input defined props (#73)

1.0.0-beta.3

February 22, 2022

beta.3 was going to be such a great release we decided to skip it and go straight to beta.4 👀 ! Only kidding. We had issues with npm and had to bump 🤦.

New @formkit/nuxt package is a full featured Nuxt 3 module that makes using FormKit with Nuxt 3 as simple as possible!
defaultConfig now includes a new package @formkit/dev which decodes FormKit’s error codes to helpful console messages (no action required) (#56).
FormKit is officially open-source under the MIT license!
The preserve key now applies to all descendants (#53).
Exports all the text formatter functions in the @formkit/i18n package (#54).
Adds 🇳🇱 Dutch language support (thanks @arjendejong12).
Adds 🇭🇷 Croatian language support (thanks @antemarkic).
Improves 🇩🇪 German language support (thanks @tosling).

📙 Documentation

New installation documentation. You no longer need an auth token to install from the @formkit organization!
Nuxt installation documentation
Improved internationalization documentation for selective message overrides.

🐛 Bug fixes

Fixes a bug that caused multi-select checkboxes to not display the current value when set from parent node and when using options prop that is stored in an external variable (#55)
Fixed a bug that caused the placeholder on select inputs to be removed if something caused the input to re-render (#52).
Fixed the select placeholder color (#51)

Forms are automatically disabled when an async submit handler is pending (#44).
Added a new prop submit-behavior to opt-out of the new automatically disabled forms.
Exports the Vue to FormKit bindings plugin as bindings in the @formkit/vue package.
The type button and submit are automatically ignored.
Introduces a new messages key to the defaultConfig to allow partial overrides to locales. This allows selective message overrides for already registered locales (#42).
The schema compiler now supports "undefined" as a valid output (in other words $: undefined would output the value undefined instead of the string "undefined").
Adds 🇮🇱 Hebrew locale (thanks @Hepi420)
Adds 🇨🇳 Chinese locale (thanks @myleslee)

🐛 Bug fixes

Fixed an issue that caused checkboxes with options to not properly hydrate when re-populated from a group, list, or form (#45).
Fixed an issue that caused checkboxes with options to not display incorrectly when missing a the label prop (#41).
Significantly improved TypeScript support for “synthetic” props (#43).

Changes the validation-behavior prop on the <FormKit> component to validation-visibility.
Changes the schema prop on the <FormKit> component to sections-schema.

🎉 New features

Adds the native file input type with support for some value-added features:
- Display only re-population.
- Drag and drop.
- Input clearing.
Adds the createInput helper function to make custom inputs easy to write.
New incomplete-message prop allows inline customization (or disabling) of the message displayed by a form when it attempts to submit and all its inputs are not valid.
Updates the defaultConfig to accept custom inputs.
Adds a prefix section key which allows content to be injected immediately before an input element.
Adds a suffix section key which allows content to be injected immediately after an input element.
🇷🇺 Russian locale (thank you @andreimakushkin!)
Refactors Genesis theme to use much more robust CSS variable structure.
Adds a new feature to schemas that allows users to prefix props and attrs properties with __raw__ to pass the raw value instead of its parsed result (#36).

📙 Documentation

New create a custom input guide.
New advanced custom input documentation page.
"Composition keys" will now be referred to as "Section keys".
Adds documentation on plugin.library — the mechanism plugins use to define new input types.
Interactive code editor for examples now supports multiple files.
In the FormKit Playground you can add new files and import them into each other. The FormKit Playground supports .vue, .js, formkit.config.js and tailwind.config.js files.
The FormKit Playground is now located at https://formkit.com/playground and old https://formkit.com/playground/vue playgrounds are deprecated.

🐛 Bug fixes

Fixes a bug that prevented the incomplete message from displaying on forms (#29).
Fixes TypeScript typings for @submit and @submit-raw events.
Fixes the order of numbers in the length and between validation messages to always place the lower number first (#35).
Fixes an issue (#32)with select lists where the :options prop would not accept number values.

New validation rule “hints” — modifiers that change a validation rule’s behavior. Supported hints allow you to:
- Run a rule when the field is empty.
- Force a rule to run even when previous rules are failing.
- Debounce a validation rule.
- Make a validation rule optional.
When an input is inside a form and unmounted (such as a v-if), it now removes it’s value from the form data and de-registers its core node.
New preserve prop allows inputs to not remove their data from groups, lists, and forms when they are removed.

🐛 Bug fixes

Fixed an issue that caused numeric value radio and checkbox options to render incorrectly.
Fixed a bug that caused the placeholder to not render when the prop came after the options prop.
Fixed a bug that caused the delay value to not be respected when set using ancestor config.

Form error handling is here. You can now set input errors on an entire form, group or list with the input-errors prop or the $formkit.setErrors() methods. Read more about it on the form docs.
New $formkit.setLocale() reactively changes the language of all displayed messages.
Adds 🇫🇷 French and 🇩🇪 German locales (thank you @HoreKk and @digitalkaoz)
Adds new rootConfig proxy object that is used to store global base config and prop values (significant refactor of configuration system).
Added ledger dependency tracking to instances of FormKitObservedNode.
The submit button on forms now use the locale for the default “Submit” label.
New child node event emitted when a parent has a child added to it.
The length rule can now take max/min arguments in either order length:15,5 or length:5,15 evaluate the same.
Adds a new getNode function to directly access a FormKit node using the composition API.
Improves the @formkit/theme css import location.

🐛 Bug Fixes

Fixed a bug that caused children of list inputs to sometimes throw an exception when display validation errors.
Improved several of the validation error messages.
Fixed an issue with select inputs prevented raw node.input() calls to not trigger reactivity in Vue.

A new $formkit schema shorthand for using FormKit inputs in a schema (Issue #15).
New disabled prop on form, list, and group inputs automatically disables all child inputs (Issue #16).
New submitAttrs prop on forms allows you to pass attributes to the form’s submit button.
Added a new universal ignore prop that prevents an input’s data from being used in a form.

🐛 Bug fixes

Fixed an issue that prevented schemas from rendering expressions when used inside the children property of a FormKit component. (Issue #21).
Added a check in case a rootClasses function incorrectly returns undefined (Issue #17).
Fixed a bug that caused a form's submit button to pollute the form’s data object with a submit_x property (Issue #22).
Fixed a bug that caused $cmp schema nodes to fail to remount if the schema’s root object was reset causing a full re-parse (Issue #14).

Docs

Getting Started

Essentials

Inputs

Plugins

Guides

API Reference

Tools

About

Sponsors

Getting Started

Essentials

Inputs

Plugins

Guides

Changelog

Improved TypeScript Support 🎉

Docs

Tools

About

Sign up for the latest news