The checkbox input uses HTML's native checkbox input. It can display one or many options to a user and is a great way to allow users to select multiple items from a list. FormKit supports both single and multiple checkbox inputs.
By default the checkbox type will render a single checkbox and uses boolean values. In order for a single checkbox to be checked — the current value of the input must match the on-value of that input (by default, a single checkbox uses true as the on-value).
In order to improve API consistency across all FormKit inputs — FormKit uses the value as the initial state of the input. The checked prop/attribute should not be used directly.
To output multiple checkboxes with a single input use the options prop. Options can be specified 3 ways:
label and value properties (the same as the select and radio inputs)The value of a checkbox input with multiple options is an array of the selected values.
The simplest way to provide options is an array of strings. The provided strings will be used for both the label and the value of the option.
You may also provide the options prop where the keys are values and the values of each property are labels.
The most flexible way to define options is by providing an array of objects. The objects must include value and label properties — but may also include a help property as well as an attrs object of additional attributes to apply to each checkbox input tag.
| Prop | Type | Default | Description |
|---|---|---|---|
| decorator-icon | String | ’’ | Specifies an icon to put in the decoratorIcon section. Shows when the checkbox is checked. Defaults to the checkboxDecorator icon. |
| options | Array/Object | [] | An object of value/label pairs or an array of strings, or an array of objects that must contain a label and value property. |
| on-value | any | true | The value when the checkbox is checked (single checkboxes only). |
| off-value | any | false | The value when the checkbox is unchecked (single checkboxes only). |
| 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.. |
The checkbox input has a different construction depending on if it's a single or multiple checkbox.
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.
| Section-key | Description |
|---|---|
| decorator | Responsible for the element immediately following the input element — usually used for styling custom checkboxes. |
| decoratorIcon | An element containing the decorator icon. |
| legend | Responsible for the fieldset’s legend element. |
| fieldset | Responsible for the fieldset when multiple options are available. |
| option | Responsible for the wrapper around each item in the options. |
| options | Responsible for the wrapper element around all of the option items. |
| Show Universal section keys | |
| 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. |