Theme

Submit

The submit input uses HTML's native button element. The label prop is used to populate the text of the button — or alternatively you can use the default slot.

Button Element

Type submit input uses a button element instead of an input=type"submit" because an input is a void element. As a container element, a button can include content and pseudo elements — making them the more flexible option for developers.

Basic Example

The easiest way to set the label of a submit button is with the label prop:

Load live example

Default slot

The default slot can also be used to add text and UI to the button:

Load live example

Event listeners

You can also bind event listeners:

Load live example

Provided submit button

Note that FormKit forms automatically output a submit button. You can opt out of the built-in submit button and use your own, but will need to re-implement features such as the loading spinner (provided by the Genesis theme) or automatic disabling of the button while the form is submitting.

Disable your submit while the form is disabled

If you use your own submit button, you can dynamically disable it according to the form's disabled status (context.disabled), which you can pull from the #default slot prop:

<FormKit
  type="form"
  :actions="false"
  #default="{ disabled }"
  @submit="yourSubmitHandler"
>
  <FormKit type="submit" :disabled="disabled" />
</FormKit>

You can also disable your own submit button via schema.

Ignored input

submit and button input types have a few unique behaviors because they are "ignored inputs" by default — meaning they have their ignoreprop set to true:

  • Plugins are not inherited - Ignored inputs do not inherit plugins from ancestors.
  • Their values are not included in parent forms - Ignored inputs do not contribute their value to any wrapping groups or forms for submission.
  • Validation does not run - Ignored inputs do not run validation.

If you need plugins to be inherited or validation to run on a buttonor submit, you can change :ignoreto false:

<FormKit type="button" :ignore="false"> Add a section </FormKit>

Props & Attributes

The submit input (along with button) is unique in that it does not actively receive input other than a transient click. However, nearly all of the base input props still technically exist on the input.

PropTypeDefaultDescription
configObject{}Configuration options to provide to the input’s node and any descendent node of this input.
delayNumber20Number of milliseconds to debounce an input’s value before the commit hook is dispatched.
dirtyBehaviorstringtouchedDetermines how the "dirty" flag of this input is set. Can be set to touched or comparetouched (the default) is more performant, but will not detect when the form is once again matching its initial state.
errorsArray[]Array of strings to show as error messages on this field.
helpString''Text for help text associated with the input.
idStringinput_{n}The unique id of the input. Providing an id also allows the input’s node to be globally accessed.
ignoreBooleanfalsePrevents an input from being included in any parent (group, list, form etc). Useful when using inputs for UI instead of actual values.
indexNumberundefinedAllows 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.
labelString''Text for the label element associated with the input.
nameStringinput_{n}The name of the input as identified in the data object. This should be unique within a group of fields.
parentFormKitNodecontextualBy default the parent is a wrapping group, list or form — but this props allows explicit assignment of the parent node.
prefix-iconString''Specifies an icon to put in the prefixIcon section.
preservebooleanfalsePreserves the value of the input on a parent group, list, or form when the input unmounts.
preserve-errorsbooleanfalseBy 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-schemaObject{}An object of section keys and schema partial values, where each schema partial is applied to the respective section.
suffix-iconString''Specifies an icon to put in the suffixIcon section.
typeStringtextThe type of input to render from the library.
validationString, Array[]The validation rules to be applied to the input.
validation-visibilityStringblurDetermines when to show an input's failing validation rules. Valid values are blur, dirty, and live.
validation-labelString{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-rulesObject{}Additional custom validation rules to make available to the validation prop.
valueAnyundefinedSeeds the initial value of an input and/or its children. Not reactive. Can seed entire groups (forms) and lists..

Sections

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.

You were too slow. Try again.
🧑‍🦰
Create profile
🚀
Quick double tap to submit.
Section-keyDescription
outerThe outermost wrapping element.
wrapperA wrapper around the label and input.
labelThe label of the input.
prefixHas no output by default, but allows content directly before an input element.
prefixIconAn element for outputting an icon before the prefix section.
innerA wrapper around the actual input element.
suffixHas no output by default, but allows content directly after an input element.
suffixIconAn element for outputting an icon after the suffix section.
inputThe input element itself.
helpThe element containing help text.
messagesA wrapper around all the messages.
messageThe element (or many elements) containing a message — most often validation and error messages.

Accessibility

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 KeyAttributeDefaultDescription
labellabelforAssociates the label to an input element. Users can click on the label to focus the input or to toggle between states.
inputinputdisabledDisables an HTML element, preventing user interaction and signaling a non-interactive state.
aria-describedbyAssociates an element with a description, aiding screen readers.
aria-requiredAdds this attribute when validation is required.
iconiconforWhenever icon is defined as a label it links it to an input element.

Keyboard Interactions

Keyboard EventDescription
TabMoves the focus to the next focusable input on the page.
Shift + TabMoves the focus to the previous focusable input on the page.