blessed-components - v1.20.0
    Preparing search index...

    Interface CreateSpotlightStateOptions

    Options accepted by createSpotlightState.

    interface CreateSpotlightStateOptions {
        defaultOpen?: boolean;
        defaultQuery?: string;
        onOpenChange?: (open: boolean) => void;
        onQueryChange?: (query: string) => void;
        open?: boolean;
        query?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    defaultOpen? defaultQuery? onOpenChange? onQueryChange? open? query?

    Properties

    defaultOpen?: boolean

    Initial state for uncontrolled usage.

    false

    defaultQuery?: string

    Initial query for uncontrolled usage.

    ''

    onOpenChange?: (open: boolean) => void

    Called when Spotlight requests an open-state change.

    onQueryChange?: (query: string) => void

    Called when Spotlight query changes.

    open?: boolean

    Controlled open state.

    query?: string

    Controlled query text.

    Settings

    Member Visibility

    On This Page

    Properties