ICommandPaletteProps
interface
Navigation
Props for OrigamCommandPalette — a global ⌘K command palette that fuzzy-searches registered commands, supports custom hotkeys, grouping, async loading and slot customisation.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- modelValueboolean
- Whether the palette is open. Used with v-model.
- hotkeyTCommandPaletteHotkey | null
- Global hotkey(s) that toggle the palette. Defaults to [["meta","k"],["ctrl","k"]]. Pass null to disable.
- commandsReadonlyArray<ICommand>
- Static command list. When omitted the palette uses commands registered via the useCommand() global registry.
- filterTCommandPaletteFilter
- placeholderstring
- Placeholder of the search input (already-translated string).
- emptyTextstring
- Empty-state message shown when no command matches the query.
- maxHeightnumber | string
- Max height of the result list. Number → px.
- widthnumber | string
- Width of the palette dialog. Number → px.
- loadingboolean
- Display a loader inside the result list (use during async command fetches).
- searchIconTIcon
- loadingIconTIcon
- closeOnSelectboolean
- Close the palette automatically when a command is selected.
- closeOnEscapeboolean
- Close when the user presses Escape.
- closeOnBackdropboolean
- Close when the user clicks the backdrop.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Minimal palette with default hotkey
Custom hotkey and width with async loading