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.

Pro Alternative

Need more flexibility than the native HTML select input provides? Check out the dropdown input available in FormKit Pro.

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.

<FormKit  type="select"  label="Which country is the smallest?"  name="small_country"  :options="[    'Monaco',    'Vatican City',    'Maldives',    'Tuvalu',  ]"/>

Which country is the smallest?

Value / Label object

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

<FormKit  type="select"  label="What planet is the largest?"  placeholder="Select a planet"  name="planet"  :options="{    mercury: 'Mercury',    venus: 'Venus',    earth: 'Earth',    mars: 'Mars',    jupiter: 'Jupiter',    saturn: 'Saturn',    uranus: 'Uranus',    neptune: 'Neptune',  }"  validation="required|is:jupiter"  validation-visibility="dirty"  :validation-messages="{    is: 'Nope! Jupiter is the largest planet',  }"/>

What planet is the largest?

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.

<FormKit  type="select"  label="What country makes the best food?"  name="country"  placeholder="Select a country"  :options="[    { label: 'France', value: 'fr', attrs: { disabled: true } },    { label: 'Germany', value: 'de', attrs: { disabled: true } },    { label: 'Spain', value: 'es', attrs: { disabled: true } },    { label: 'Italy', value: 'ie' },    { label: 'Greece', value: 'gr', attrs: { disabled: true } },  ]"  help="Don’t worry, you can’t get this one wrong."/>

What country makes the best food?

Don’t worry, you can’t get this one wrong.

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
    }
  }
]

Option groups (`optgroup`)

Using the array of objects syntax you can also create option groups (<optgroup> in HTML). To do so provide a group option:

<template>  <FormKit    type="select"    label="Letters or numbers"    :options="[      {        group: 'Letters',        options: ['A', 'B', 'C'],      },      {        group: 'Numbers',        options: [1, 2, 3],      },    ]"  ></FormKit></template>

Letters or numbers

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.

<FormKit  type="select"  label="Where would you prefer to live?"  name="planet"  v-model="value">  <optgroup label="Inner Planets">    <option value="mercury">Mercury</option>    <option value="venus">Venus</option>    <option value="earth">Earth</option>    <option value="mars">Mars</option>  </optgroup>  <optgroup label="Outer planets">    <option value="jupiter">Jupiter</option>    <option value="saturn">Saturn</option>    <option value="uranus">Uranus</option>    <option value="neptune">Neptune</option>  </optgroup></FormKit><pre wrap>{{ value }}</pre>

Where would you prefer to live?

earth

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.

<script setup>import { ref } from 'vue'const values = ref(['allergies'])</script><template>  <FormKit    v-model="values"    type="select"    multiple    label="Serious medical conditions"    name="medical_conditions"    :options="[      { label: 'Outie belly button', value: 'outie' },      { label: 'Large feet', value: 'lg-feet' },      { label: 'Neck beard', value: 'neard' },      { label: 'Tiny hands', value: 'trump-hands' },    ]"    help="Select all that apply by holding command (macOS) or control (PC)."  />  <pre wrap>{{ values }}</pre></template>

Serious medical conditions

Select all that apply by holding command (macOS) or control (PC).

[
  "allergies"
]

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
`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.
`select-icon`	`String`	`’’`	Specifies an icon to put in the `selectIcon` section. Defaults to the `select` icon.
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..

Sections & slot data

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.

Default

A native HTML select element with options rendered inside.

outer

wrapper

label

Choose a country

inner

prefixIcon

prefix

input

option

United States

selectIcon

▼

suffix

suffixIcon

help

Select your country of residence.

messages

message

Please select a country.

Click on a section to lock focus to the chosen section. Click locked section again to unlock.

With option groups

When options have a group property, they are rendered inside optgroup elements.

outer

wrapper

label

Choose a country

inner

prefixIcon

prefix

input

optGroup

North America

option

United States

selectIcon

▼

suffix

suffixIcon

help

Select your country of residence.

messages

message

Please select a country.

Click on a section to lock focus to the chosen section. Click locked section again to unlock.

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.
`selectIcon`	An element for outputting an icon for opening the select list. Usually a down arrow.
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.

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 markup
ARIA attributes
Keyboard accessibility
Focus indicators
Color contrast with the provided theme
Accessible labels, help text, and errors

Accessibility attributes

Section Key	Attribute	Value	Description
`label`	`label`	`for`	Associates a label to an input element. Users can click on the label to focus the input or to toggle between states.
`input`	`input`	`disabled`	Disables an HTML element, preventing user interaction and signaling a non-interactive state.
		`aria-describedby`	Associates an element with a description, aiding screen readers.
		`aria-required`	Added when input validation is set to `required`.
`icon`	`icon`	`for`	Links icon to input element when icon in rendered as a `label`.

Keyboard Interactions

Keyboard Event	Description
`Space`	Opens the select options when the input is focused. Selects an item when an option is focused
`Esc`	Closes the select options when the input is focused.
`↑`	Opens the listbox when input is focused. Navigates to previous option in select options.
`↓`	Opens the listbox when input is focused. Navigates to next option in select options.
Universal Keyboard Events
`Tab`	Moves the focus to the next focusable element on the page.
`Shift`+`Tab`	Moves the focus to the previous focusable element on the page.