The select input uses HTML's native select input. Select inputs can be single value selections, or multi-value selections by using the multiple attribute. There are 4 ways to provide options to a select input:
label and value properties (the same as the checkbox and radio inputs)<option> tags directly inside the default slot.Select lists are most commonly used to select a single item from a list of options.
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 select input tag.
<option> element, your object can also contain an attrs property.[
{
label: 'My Label',
value: 'a-value',
attrs: {
disabled: true
}
}
]
Sometimes it may be desirable to manually output the contents of a select list in order to create specialized structures. This can be done by using the default slot to explicitly output your options.
placeholder or options props.
The select input also supports a multiple attribute that allows for multi-selection. When used with FormKit, this option produces an array of values.
multiple attribute can be challenging for some users because they require holding-down the control or command keys to perform multiple selections. Depending on your audience, you may want to consider using a checkbox input with options instead.
multiple attribute you must explicitly assign the selected attribute to each option.
| Prop | Type | Default | Description |
|---|---|---|---|
| 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. |
| placeholder | String | none | When defined, FormKit injects a non-selectable hidden option tag as the first value of the list to serve as a placeholder. |
| 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. |
| 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. |
| 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. |
| preserve | boolean | false | Preserves the value of the input on a parent group, list, or form when the input unmounts. |
| sections-schema | Object | {} | An object of section keys and schema partial values, where each schema partial is applied to the respective 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. |
| Section-key | Description |
|---|---|
| option | Responsible for rendering each option. Context includes an option property with the option being rendered. This object includes label and value properties. |
| Show Universal Props | |
| outer | The outermost wrapping element. |
| wrapper | A wrapper around the label and input. |
| label | The label of the input. |
| prefix | Has output by default, but allows content directly before an input element. |
| inner | A wrapper around the actual input element. |
| suffix | Has output by default, but allows content directly after an input element. |
| 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. |