Skip to content
Binary Dreams UI Kit reference CommandPalette

Command palette

Searchable command dialog with grouped results.

Loading interactive example

Use CommandPalette for searchable application commands when the available actions span several groups. Give duplicate titles distinct `id` values; titles remain searchable.

API

MemberTypeKindRequiredDefault
emptySnippetsnippetNoundefined
filterboolean | ((item: CommandPaletteItem, query: string) => boolean)callbackNotrue
hotkeystring | falsepropNo'k'
itemsCommandPaletteItem[] | CommandPaletteGroup[]propNo[]
labelstringpropNo'Search'
onSelect(item: CommandPaletteItem) => voidcallbackNoundefined
onSubmit(query: string) => voidcallbackNoundefined
openbooleanbindingNofalse
placeholderstringpropNo'Search…'
querystringbindingNo''
rowSnippet<[CommandPaletteItem, boolean]>snippetNoundefined

Source

Loading source