Skip to content

Command

Overview

Root of a command palette with built-in filtering, providing context to child components.

Theme entry: Command

Props

NameTypeRequiredDefaultDescription
themeOverrideString|Object|ArraynullA partial theme object merged with the component's default theme; accepts a class string, class array, or theme object.
classimport('vue').HTMLAttributes['class']undefinedAdditional CSS classes to apply to the root element.
modelValuestring|number|boolean|object|array""The controlled value. Can be bound with v-model.
defaultValuestring|number|boolean|object|arrayundefinedThe initial value when uncontrolled.
multiplebooleanundefinedWhether multiple options can be selected.
orientationstringundefinedThe orientation of the listbox for arrow navigation.
dirstringundefinedThe reading direction.
disabledbooleanundefinedWhen true, prevents user interaction.
selectionBehaviorstringundefinedHow multiple selection behaves in the collection.
highlightOnHoverbooleanundefinedWhen true, hovering an item triggers highlight.
bystring|funcundefinedField for object comparison, or a custom comparison function.
namestringundefinedThe name submitted with the form.
requiredbooleanundefinedWhen true, the field is required.
asstring|objectundefinedThe HTML element or component to render as.
asChildbooleanundefinedWhether to render as a child element.

Slots

default

Slot.

Events

NameDescription
update:modelValueEmitted when the value changes.
highlightEmitted when an item is highlighted.

Full event reference

Source

client/lib/controls/command/Command.vue

Documents matching: server v3.0.0a1.post1client v3.0.0-alpha.2