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

    Interface CommandPaletteItem<C>

    A single action that can be executed from the command palette.

    interface CommandPaletteItem<C = unknown> {
        context?: C;
        disabled?: boolean;
        group?: string;
        icon?: string;
        id: string;
        keywords?: readonly string[];
        label: string;
        shortcut?: string;
    }

    Type Parameters

    • C = unknown

      Optional context type carried on the command.

    Index

    Properties

    context? disabled? group? icon? id keywords? label shortcut?

    Properties

    context?: C

    Optional arbitrary context payload.

    disabled?: boolean

    Whether this command is currently disabled.

    group?: string

    Optional group name. Commands with the same group are rendered under a shared heading.

    icon?: string

    Optional SVG icon content (inner <path> string for a 24×24 grid).

    id: string

    Unique identifier for this command.

    keywords?: readonly string[]

    Optional keywords that improve search matching beyond the label text.

    label: string

    Display label shown in the palette list.

    shortcut?: string

    Optional keyboard shortcut hint displayed on the right side (e.g. "Cmd+S", "Ctrl+Shift+P"). Purely cosmetic — the palette does not bind these shortcuts.

    Settings

    Member Visibility

    On This Page

    Properties