The password input uses HTML's native password input. It allows a user to privately enter their password. When creating new passwords, this input is often compiled with the confirm validation rule.
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 commithook 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.
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.
Password
🤫
···········
🤐
Keep this hidden in a safe place.
Password is required.
Section-key
Description
outer
The outermost wrapping 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 outputting 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 outputting an icon after the suffix section.
input
The input element itself.
help
The element containing help text.
messages
A wrapper around all the messages.
message
The element (or many elements) containing a message — most often validation and error messages.
All FormKit inputs are designed with the following accessibility considerations in mind. Help us continually improve accessibility for all by filing accessibility issues here:
Semantic markupAria attributesKeyboard accessibleFocus indicatorsColor contrast with the provided themeAccessible labels, help text, and errors
Section Key
Attribute
Default
Description
label
label
for
Associates the label to an input element. Users can click on the label to focus the input or to toggle between states.
input
input
disabled
Disables an HTML element, preventing user interaction and signaling a non-interactive state.
aria-describedby
Associates an element with a description, aiding screen readers.
aria-required
Adds this attribute when validation is required.
icon
icon
for
Whenever icon is defined as a label it links it to an input element.