Form Select ​

Generate your select options by passing an array or object to the options props:

<template>
  <BFormSelect v-model="ex1Selected" :options="ex1Options" />

  <BFormSelect v-model="ex1Selected" :options="ex1Options" size="sm" class="mt-3" />

  <div class="mt-3">
    Selected: <strong>{{ ex1Selected }}</strong>
  </div>
</template>

<script setup lang="ts">
const ex1Options = [
  {value: null, text: 'Please select an option'},
  {value: 'a', text: 'This is First option'},
  {value: 'b', text: 'Selected Option'},
  {value: {C: '3PO'}, text: 'This is an option with object value'},
  {value: 'd', text: 'This one is disabled', disabled: true},
]

const ex1Selected = ref(null)
</script>

You can even define option groups with the options prop:

<template>
  <BFormSelect v-model="exGroupSelected" :options="ex1GroupOptions" />

  <div class="mt-3">
    Selected: <strong>{{ exGroupSelected }}</strong>
  </div>
</template>

<script setup lang="ts">
const ex1GroupOptions = [
  {value: null, text: 'Please select an option'},
  {value: 'a', text: 'This is First option'},
  {value: 'b', text: 'Selected Option', disabled: true},
  {
    label: 'Grouped options',
    options: [
      {value: {C: '3PO'}, text: 'Option with object value'},
      {value: {R: '2D2'}, text: 'Another option with object value'},
    ],
  },
]

const exGroupSelected = ref()
</script>

Or manually provide your options and option groups:

<template>
  <BFormSelect v-model="exManualSelected">
    <BFormSelectOption :value="null">Please select an option</BFormSelectOption>
    <BFormSelectOption value="a">Option A</BFormSelectOption>
    <BFormSelectOption value="b" disabled>Option B (disabled)</BFormSelectOption>
    <BFormSelectOptionGroup label="Grouped options">
      <BFormSelectOption :value="{C: '3PO'}">Option with object value</BFormSelectOption>
      <BFormSelectOption :value="{R: '2D2'}">Another option with object value</BFormSelectOption>
    </BFormSelectOptionGroup>
  </BFormSelect>

  <div class="mt-3">
    Selected: <strong>{{ exManualSelected }}</strong>
  </div>
</template>

<script setup lang="ts">
const exManualSelected = ref(null)
</script>

Feel free to mix the options prop with BFormSelectOption and BFormSelectOptionGroup. Manually placed options and option groups will appear below the options generated via the options prop. To place manual options and option groups above the options specified by the options prop, use the named slot first.

<template>
  <BFormSelect v-model="exFirstSlotSelected" :options="exFirstSlotOptions" class="mb-3">
    <!-- This slot appears above the options from 'options' prop -->
    <template #first>
      <BFormSelectOption :value="null" disabled>-- Please select an option --</BFormSelectOption>
    </template>

    <!-- These options will appear after the ones from 'options' prop -->
    <BFormSelectOption value="C">Option C</BFormSelectOption>
    <BFormSelectOption value="D">Option D</BFormSelectOption>
  </BFormSelect>

  <div class="mt-3">
    Selected: <strong>{{ exFirstSlotSelected }}</strong>
  </div>
</template>

<script setup lang="ts">
const exFirstSlotOptions = [
  {value: 'A', text: 'Option A (from options prop)'},
  {value: 'B', text: 'Option B (from options prop)'},
]

const exFirstSlotSelected = ref(null)
</script>

Options property ​

options can be an array of strings or objects, or a key-value object. Available fields:

• value The selected value which will be set on v-model
• disabled Disables item for selection
• text Display text, or html Display basic inline html

value can be a string, number, or simple object. Avoid using complex types in values.

If both html and text are provided, html will take precedence. Only basic/native HTML is supported in the html field (components will not work). Note that not all browsers will render inline html (i.e. <i>, <strong>, etc.) inside <option> elements of a <select>.

Options as an array ​

const options = ['A', 'B', 'C', {text: 'D', value: {d: 1}, disabled: true}, 'E', 'F']

If an array entry is a string, it will be used for both the generated value and text fields.

You can mix using strings and objects in the array.

Internally, BootstrapVueNext will convert the above array to the following array (the array of objects) format:

const options = [
  {text: 'A', value: 'A', disabled: false},
  {text: 'B', value: 'B', disabled: false},
  {text: 'C', value: 'C', disabled: false},
  {text: 'D', value: {d: 1}, disabled: true},
  {text: 'E', value: 'E', disabled: false},
  {text: 'F', value: 'F', disabled: false},
]

Options as an array of objects ​

const options = [
  {text: 'Item 1', value: 'first'},
  {text: 'Item 2', value: 'second'},
  {html: '<b>Item</b> 3', value: 'third', disabled: true},
  {text: 'Item 4'},
  {text: 'Item 5', value: {foo: 'bar', baz: true}},
]

If value is missing, then text will be used as both the value and text fields. If you use the html property, you must supply a value property.

To define option groups, just add an object with a label prop as the groups name and a options property with the array of options of the group.

const options = [
  {text: 'Item 1', value: 'first'},
  {text: 'Item 2', value: 'second'},
  {
    label: 'Grouped options',
    options: [{html: '<b>Item</b> 3', value: 'third', disabled: true}, {text: 'Item 4'}],
  },
  {text: 'Item 5', value: {foo: 'bar', baz: true}},
]

Changing the option field names ​

If you want to customize the field property names (for example using name field for display text) you can easily change them by setting the text-field, html-field, value-field, and disabled-field props to a string that contains the property name you would like to use:

<template>
  <BFormSelect
    v-model="exFieldNamesSelected"
    :options="exFieldNamesOptions"
    class="mb-3"
    value-field="item"
    text-field="name"
    disabled-field="notEnabled"
  />

  <div class="mt-3">
    Selected: <strong>{{ exFieldNamesSelected }}</strong>
  </div>
</template>

<script setup lang="ts">
const exFieldNamesOptions = [
  {item: 'A', name: 'Option A'},
  {item: 'B', name: 'Option B'},
  {item: 'D', name: 'Option C', notEnabled: true},
  {item: {d: 1}, name: 'Option D'},
]

const exFieldNamesSelected = ref('A')
</script>

Option notes ​

If the initial value of your v-model expression does not match any of the options, the BFormSelect component (which is a native HTML5 <select> under the hood) will render in an unselected state. On iOS this will cause the user not being able to select the first item because iOS does not fire a change event in this case. It is therefore recommended providing a disabled option with an empty value as your first option.

<BFormSelect v-model="selected" :options="options">
  <template #first>
    <BFormSelectOption value="" disabled>-- Please select an option --</BFormSelectOption>
  </template>
</BFormSelect>

See the Vue select documentation for more details.

Standard (single) select ​

By default, Bootstrap v5's custom select styling is applied.

Value in single mode ​

In non multiple mode, BFormSelect returns the single value of the currently selected option.

<template>
  <BFormSelect v-model="ex1Selected" :options="ex1Options" />

  <div class="mt-3">
    Selected: <strong>{{ ex1Selected }}</strong>
  </div>
</template>

<script setup lang="ts">
const ex1Options = [
  {value: null, text: 'Please select an option'},
  {value: 'a', text: 'This is First option'},
  {value: 'b', text: 'Selected Option'},
  {value: {C: '3PO'}, text: 'This is an option with object value'},
  {value: 'd', text: 'This one is disabled', disabled: true},
]

const ex1Selected = ref()
</script>

Select sizing (displayed rows) ​

You can use the select-size prop to switch the custom select into a select list-box, rather than a dropdown. Set the select-size prop to a numerical value greater than 1 to control how many rows of options are visible.

Note when select-size is set to a value greater than 1, the Bootstrap v5 custom styling will not be applied, unless the multiple prop is also set.

Note that not all mobile browsers will show the select as a list-box.

<template>
  <BFormSelect v-model="ex1Selected" :options="ex1Options" :select-size="4" />

  <div class="mt-3">
    Selected: <strong>{{ ex1Selected }}</strong>
  </div>
</template>

<script setup lang="ts">
const ex1Options = [
  {value: null, text: 'Please select an option'},
  {value: 'a', text: 'This is First option'},
  {value: 'b', text: 'Selected Option'},
  {value: {C: '3PO'}, text: 'This is an option with object value'},
  {value: 'd', text: 'This one is disabled', disabled: true},
]

const ex1Selected = ref()
</script>

Multiple select support ​

Enable multiple select mode by setting the prop multiple, and control how many rows are displayed in the multiple select list-box by setting select-size to the number of rows to display. The default is to let the browser use its default (typically 4).

Value in multiple mode ​

In multiple mode, BFormSelect always returns an array of option values. You must provide an array reference as your v-model when in multiple mode.

<template>
  <BFormSelect v-model="exMultiSelected" :options="exMultiOptions" multiple :select-size="4" />

  <div class="mt-3">
    Selected: <strong>{{ exMultiSelected }}</strong>
  </div>
</template>

<script setup lang="ts">
const exMultiOptions = [
  {value: 'a', text: 'This is First option'},
  {value: 'b', text: 'Default Selected Option'},
  {value: 'c', text: 'This is another option'},
  {value: 'd', text: 'This one is disabled', disabled: true},
  {value: 'e', text: 'This is option e'},
  {value: 'f', text: 'This is option f'},
  {value: 'g', text: 'This is option g'},
]

const exMultiSelected = ref(['b'])
</script>

Control sizing ​

Set the form-control text size using the size prop to sm or lg for small or large respectively.

By default, BFormSelect will occupy the full width of the container that it appears in. To control the select width, place the input inside standard Bootstrap grid column.

Autofocus ​

When the autofocus prop is set on BFormSelect, the select will be auto-focused when it is inserted (i.e. mounted) into the document or re-activated when inside a Vue KeepAlive component. Note that this prop does not set the autofocus attribute on the select, nor can it tell when the select becomes visible.

Contextual states ​

Bootstrap includes validation styles for valid and invalid states on most form controls.

Generally speaking, you'll want to use a particular state for specific types of feedback:

• false (denotes invalid state) is great for when there is a blocking or required field. A user must fill in this field properly to submit the form
• true (denotes valid state) is ideal for situations when you have per-field validation throughout a form and want to encourage a user through the rest of the fields
• null Displays no validation state (neither valid nor invalid)

To apply one of the contextual state icons on BFormSelect, set the state prop to false (for invalid), true (for valid), or null (no validation state).

Conveying contextual validation state to assistive technologies and colorblind users ​

Using these contextual states to denote the state of a form control only provides a visual, color-based indication, which will not be conveyed to users of assistive technologies - such as screen readers - or to colorblind users.

Ensure that an alternative indication of state is also provided. For instance, you could include a hint about state in the form control's <label> text itself, or by providing an additional help text block (via BFormGroup or BForm*Feedback). Specifically for assistive technologies, invalid form controls can also be assigned an aria-invalid="true" attribute (see below).

ARIA aria-invalid attribute ​

When BFormSelect has an invalid contextual state (i.e. state = false) you may also want to set the BFormSelect prop aria-invalid to true.

Supported invalid values are:

• false (default) No errors detected
• true The value has failed validation

When state is set to false, aria-invalid will also be set to true.

Non custom style select ​

Set the prop plain to have a native browser <select> rendered (although the class .form-control will always be placed on the select).

A plain select will always be rendered for non multiple selects which have the select-size prop set to a value greater than 1.