Docs Navigation

Button input

The button 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.

Load Live Example

Props & Attributes

The button input 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.

Importantly the ignore prop is automatically set to true — meaning even if a button is given a value, it will not communicate it with the parent form. However, this default behavior can be changed by setting the prop :ignore="false".

Prop Type Default Description
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.
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.
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.
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.

Section keys

You can target a specific section of an input using that section's "key". Read more about sections here.

    Validation messages about the button.
    Submit application
    Click this button to submit your application.
      Section-key Description
      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.
      innerA wrapper around the actual input element.
      suffixHas no output by default, but allows content directly after an input element.
      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.