Skip to content

CommandDialog ​

Overview ​

Wraps Command inside a modal dialog for use as a floating command palette.

Theme entry: CommandDialog

Props ​

NameTypeRequiredDefaultDescription
themeOverrideObjectnullA partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants.
classimport('vue').HTMLAttributes['class']undefinedAdditional CSS classes to apply to the root element.
openbooleanundefinedThe controlled open state. Can be bound with v-model:open.
defaultOpenbooleanundefinedThe open state when initially rendered. Use when you do not need to control the open state.
modalbooleanundefinedWhen true, interaction with outside elements is disabled and only dialog content is visible to screen readers.
titlestring"Command Palette"Accessible title shown in the dialog header.
descriptionstring"Search for a command to run..."Accessible description shown in the dialog header.

Slots ​

default ​

Scoped slot.

Events ​

NameDescription
update:openEmitted when the open state changes.

Full event reference

Source ​

client/lib/controls/command/CommandDialog.vue