Forms
Multi Select
+ CMultiSelect selects zero or more existing options and writes them to an
+ array. Its popup stays open while users toggle several items.
+
Object options
+
+ Raw objects follow the same mapping rules as CSelect. Set
+ option-label for the displayed field and omit option-value to bind
+ the complete selected objects. option-key also lets the component match object
+ selections by a stable field such as id. CMultiSelect always emits
+ a new array instead of mutating the array supplied by the parent.
+
Mapped and structured options
+
+ Add option-value when the model should contain one field, such as an ID. If
+ options already use the standard label and value fields, they are
+ interpreted automatically and may also include disabled or hidden.
+
Filter and clear
+
+ filterable lets users narrow the existing options without accepting arbitrary
+ text. Selecting a result toggles it and keeps the list open. clearable adds a
+ compact button that replaces the model with an empty array.
+
+ Use Arrow Up or Arrow Down to move, Enter to toggle, and Escape to close the popup. In the + non-filterable control, Space also toggles the highlighted option. +
+Sizes and states
+Properties
+-
+
model-value- Array of selected primitives or objects, used by
v-model. options- Array of
{ label, value }records or raw objects. option-label- Property path or function used to label raw object options.
option-value- Property path or function selecting each bound value. Omit it to bind complete objects.
option-key- Property path or function providing stable rendering and object-selection identity.
filterable- Adds existing-option filtering to the control.
clearable- Adds a button that clears all selections to an empty array.
placeholder- Text displayed while no values are selected.
sizesmall,medium, orlarge.disabled- Disables interaction and focus.
required- Marks the control as requiring at least one selection for accessibility.
invalid- Applies invalid styling and
aria-invalid.