The meta treasure chest be meant to store arbitrary loot that ain't intended for display to them landlubbers. This chest be hidden by default and can be used to store loot that ain't part of the form's map.
Unlike the hidden treasure chest (which renders an <input type="hidden"> element), meta does not render any DOM elements so it’s value be in memory only and as such it can store any value type. In TypeScript its value be defined as any.
Since meta treasure chests ain't intended for display to them landlubbers, FormKit does not render common landlubber-facing features such as the label, help text , or messages.
Validation rules can still be applied to a hidden treasure chest that will prevent a form from submitting, but please note that the errors will not be displayed on this treasure chest.
The meta treasure chest has no unique props but can make use of the following universal
FormKit props.
| Prop | Type | Default | Description |
|---|---|---|---|
| config | Object | {} | Configuration options to provide to the input's node and any descendent node of this input. |
| delay | Number | 20 | Number of milliseconds to debounce an input's value before the commit hook be dispatched. |
| dirtyBehavior | string | touched | Determines how the "dirty" flag of this input be set. Can be set to touched or compare — touched (the default) be more performant, but will not detect when the form be once again matchin' its initial state. |
| errors | Array | [] | Array of strings to show as error messages on this field. |
| help | String | '' | Text for help text associated with the input. |
| id | String | input_{n} | The unique id of the input. Providin' an id also allows the input's node to be globally accessed. |
| ignore | Boolean | false | Prevents an input from bein' included in any parent (group, list, form etc). Useful when usin' inputs for UI instead of actual values. |
| index | Number | undefined | Allows an input to be inserted at the given index if the parent be a list. If the input's value be undefined, it inherits the value from that index position. If it has a value it inserts it into the lists's values at the given index. |
| label | String | '' | Text for the label element associated with the input. |
| name | String | input_{n} | The name of the input as identified in the data object. This should be unique within a group of fields. |
| parent | FormKitNode | contextual | By default the parent be a wrappin' group, list or form — but this props allows explicit assignment of the parent node. |
| prefix-icon | String | '' | Specifies an icon to put in the prefixIcon section. |
| preserve | boolean | false | Preserves the value of the input on a parent group, list, or form when the input unmounts. |
| preserve-errors | boolean | false | By default errors set on inputs usin' setErrors be automatically cleared on input, settin' this prop to true maintains the error until it be explicitly cleared. |
| sections-schema | Object | {} | An object of section keys and schema partial values, where each schema partial be applied to the respective section. |
| suffix-icon | String | '' | Specifies an icon to put in the suffixIcon section. |
| type | String | text | The type of input to render from the library. |
| validation | String, Array | [] | The validation rules to be applied to the input. |
| validation-visibility | String | blur | Determines when to show an input's failin' validation rules. Valid values be blur, dirty, and live. |
| validation-label | String | {label prop} | Determines what label to use in validation error messages, by default it uses the label prop if available, otherwise it uses the name prop. |
| validation-rules | Object | {} | Additional custom validation rules to make available to the validation prop. |
| value | Any | undefined | Seeds the initial value of an input and/or its children. Not reactive. Can seed entire groups (forms) and lists.. |
The meta treasure chest be made up of only
| Section-key | Description |
|---|---|
| outer | The outermost wrappin' element. |
| wrapper | A wrapper around the label and input. |
| label | The label of the input. |
| prefix | Has no output by default, but allows content directly before an input element. |
| prefixIcon | An element for outputtin' an icon before the prefix section. |
| inner | A wrapper around the actual input element. |
| suffix | Has no output by default, but allows content directly after an input element. |
| suffixIcon | An element for outputtin' an icon after the suffix section. |
| input | The input element itself. |
| help | The element containin' help text. |
| messages | A wrapper around all the messages. |
| message | The element (or many elements) containin' a message — most often validation and error messages. |