Select

    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:

    • An array of strings
    • An object of value/label pairs
    • An array of objects with label and value properties (the same as the checkbox and radio inputs)
    • Using <option> tags directly inside the default slot.

    Single selection

    Select lists are most commonly used to select a single item from a list of options.

    Array of strings

    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.

    Load Live Example

    Value / Label object

    You may also provide the options prop where the keys are values and the values of each property are labels.

    Load Live Example

    Array of objects

    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.

    Load Live Example
    Option attributes
    To pass additional attributes to each <option> element, your object can also contain an attrs property.

    [ { label: 'My Label', value: 'a-value', attrs: { disabled: true } } ]

    Default slot

    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.

    Load Live Example
    warning
    When using the default slot to output options, you should not use the placeholder or options props.

    Multiple

    The select input also supports a multiple attribute that allows for multi-selection. When used with FormKit, this option produces an array of values.

    Load Live Example
    Alternatives
    Select inputs with the 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 with default slot
    When using the default slot in conjunction with the multiple attribute you must explicitly assign the selected attribute to each option.

    Props & Attributes

    Prop Type Default Description
    optionsArray/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.
    placeholderStringnoneWhen defined, FormKit injects a non-selectable hidden option tag as the first value of the list to serve as a placeholder.
    select-iconString’’Specifies an icon to put in the selectIcon section. Defaults to the down icon.
    Show universal props
    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.
    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.

      Smoothie size
      👩🏼‍🦱
      Medium
      Choose a smoothie size.
      You must make a selection.
        Section-key Description
        optionResponsible for rendering each option. Context includes an option property with the option being rendered. This object includes label and value properties.
        selectIconAn element for outputting an icon for opening the select list. Usually a down arrow.
        Show universal section keys
        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.