@theredhead — Frontend Library - v1.0.0
    Preparing search index...

    Class UICommandPalette<C>

    A keyboard-triggered command palette that provides quick access to application actions through a searchable, grouped list.

    Open with Cmd+K / Ctrl+K (when globalShortcut is enabled) or by setting the open model to true.

    <ui-command-palette
      [commands]="commands"
      [(open)]="paletteOpen"
      (execute)="onExecute($event)"
    />

    <ui-command-palette
      [commands]="commands"
      [maxRecent]="5"
      [(open)]="paletteOpen"
      (execute)="onExecute($event)"
    />

    Type Parameters

    • C = unknown
    Index

    Constructors

    constructor

    Properties

    ariaLabel commands execute globalShortcut maxRecent open placeholder

    Methods

    close show

    Constructors

    • Type Parameters

      • C = unknown

      Returns UICommandPalette<C>

    Properties

    ariaLabel: InputSignal<string> = ...

    Accessible label for the palette.

    commands: InputSignal<readonly CommandPaletteItem<C>[]> = ...

    The full list of available commands.

    execute: OutputEmitterRef<CommandExecuteEvent<C>> = ...

    Emitted when a command is executed.

    globalShortcut: InputSignal<boolean> = ...

    Whether the global Cmd+K / Ctrl+K keyboard shortcut is active. Defaults to true.

    maxRecent: InputSignal<number> = ...

    Maximum number of recent commands to track. Set to 0 to disable the recent-items section. Defaults to 5.

    open: ModelSignal<boolean> = ...

    Whether the palette is open (two-way bindable).

    placeholder: InputSignal<string> = ...

    Placeholder text for the search input.

    Methods

    • Programmatically close the palette.

      Returns void

    • Programmatically open the palette.

      Returns void

    Settings

    Member Visibility

    On This Page

    Basic usageWith recent items
    Constructors
    Properties
    Methods