Command

A command palette (filterable actions).

  • New file⌘N
  • Open folder⌘O
  • Toggle theme
  • Keyboard shortcuts⌘K

Single group

  • New file
  • Search
  • Settings

Checkable

  • New file
  • Search
  • Settings

API reference

Inputs

PropTypeDefaultDescription
groupsreadonly CommandGroup[][]Grouped commands shown in the palette and filtered as the user types.
placeholderstring'Type a command or search…'Placeholder text for the search input.
checkablebooleanfalseRender a checkmark column; activating an item toggles its checked state.

Outputs

EventPayloadDescription
selectedCommandItemEmits the chosen command when an item is activated (click or Enter).

Types

CommandGroup

FieldTypeDescription
label?stringOptional heading rendered above the group's items.
itemsCommandItem[]Commands belonging to this group.

CommandItem

FieldTypeDescription
labelstringText shown for the command and matched against the search query.
value?stringIdentifying value emitted on selection; falls back to the label.
shortcut?stringKeyboard shortcut hint shown trailing the label.

Every ng-blatui component also accepts a class input to merge extra Tailwind classes onto the host.