Introducing KickStart — AI generated FormKit forms in seconds. Generate from a screenshot, edit with drag-and-drop or conversational AI, copy & paste as components or schema!
Try for free
The currency
input allows for restricted input of values based on the provided currency and locale.
The currency
prop is the three letter currency code and sets the proper formatting for the specified currency. For a full list of supported currency types check: https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes
By default, the locale used will be that of what is set in your formkit.config.ts
. This can be overriden with the display-locale
prop. For example, en
, de
, en-IN
, zh-CN
, etc, etc.
If you would like to prevent decimals from being displayed, set decimals
to false
or 0
.
You can also choose to set a minimum number of decimals with the min-decimals
prop. For example, setting the prop min-decimals="2"
will always show 2 decimal points.
Setting the props min
or max
will prevent entry of a higher or lower value.
Value scan be incremented and decremented by use of the up/down keys. The degree by which the value changes is determined by the step
prop.
Prop | Type | Default | Description |
---|---|---|---|
currency | string | USD | Set the specified currency to use for this input |
displayLocale | string | en-US | Set the desired display locale to use for this input |
decimals | boolean|number | null | Choose to either completely disallow decimals or override the maximum number of decimals for the input |
minDecimals | number | null | Choose to show a minimum number of decimals should your input require this |
min | number | null | Minimum numeric value allowed. If zero or above, negatives will not be allowed |
max | number | null | Maximum numeric value allowed for this input |
step | number | 1 | When using the up/down keys, how much to modify the current value. |
valueFormat | string | number | Choose between number and string whether you want a numeric value or a parsed string value |
Show Universal props | |||
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 is dispatched. |
dirtyBehavior | string | touched | Determines how the "dirty" flag of this input is set. Can be set to touched or compare — touched (the default) is more performant, but will not detect when the form is once again matching 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. Providing an id also allows the input’s node to be globally accessed. |
ignore | Boolean | false | Prevents an input from being included in any parent (group, list, form etc). Useful when using inputs for UI instead of actual values. |
index | Number | undefined | Allows an input to be inserted at the given index if the parent is a list. If the input’s value is 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 is a wrapping 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 using setErrors are automatically cleared on input, setting this prop to true maintains the error until it is explicitly cleared. |
sections-schema | Object | {} | An object of section keys and schema partial values, where each schema partial is 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 failing validation rules. Valid values are 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.. |
You can target a specific section of an input using that section's "key", allowing you to modify that section's classes, HTML (via :sections-schema
, or content (via slots)). Read more about sections here.
Keyboard Event | Description |
---|---|
Up + Down | Increments through input value by current step amount. |
Show Universal keyboard event | |
Tab | Moves the focus to the next focusable input on the page. |
Shift + Tab | Moves the focus to the previous focusable input on the page. |