UI Headless Runtime API - v1.0.0
    Preparing search index...

    Interface CommandPaletteOptions

    Command Palette configuration.

    interface CommandPaletteOptions {
        defaultQuery?: string;
        dialog?: DialogOptions;
        getQuery?: () => string;
        matcher?: (command: Readonly<CommandItem>, query: string) => number;
        onQueryChange?: (
            query: string,
            details: ChangeDetails<CommandPaletteReason>,
        ) => void;
        shortcut?: CommandShortcut;
        subscribeQuery?: (listener: () => void) => () => void;
    }
    Index

    Properties

    defaultQuery? dialog? getQuery? matcher? onQueryChange? shortcut? subscribeQuery?

    Properties

    defaultQuery?: string

    Initial query in uncontrolled mode.

    dialog?: DialogOptions

    Dialog state and focus configuration.

    getQuery?: () => string

    Reads consumer-owned query.

    matcher?: (command: Readonly<CommandItem>, query: string) => number

    Replaces the default ordered fuzzy score.

    onQueryChange?: (
        query: string,
        details: ChangeDetails<CommandPaletteReason>,
    ) => void

    Receives query change requests.

    shortcut?: CommandShortcut

    Global shortcut configuration.

    subscribeQuery?: (listener: () => void) => () => void

    Subscribes to external query changes.

    Settings

    Member Visibility

    On This Page

    Properties