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

    Interface NavigationListData<TItem>

    Stateful data accepted by the Blessed navigationList adapter.

    interface NavigationListData<
        TItem extends NavigationListItem = NavigationListItem,
    > {
        badgeSeparator?: string;
        characters?: NavigationListCharacters;
        defaultValue?: string;
        emptyText?: string;
        focusedId?: string;
        items: readonly TItem[];
        onValueChange?: (value: string) => void;
        onFocusedIdChange?: (focusedId: string) => void;
        value?: string;
    }

    Type Parameters

    Index

    Properties

    badgeSeparator? characters? defaultValue? emptyText? focusedId? items onValueChange? onFocusedIdChange? value?

    Properties

    badgeSeparator?: string

    Text inserted between a label and badge.

    characters?: NavigationListCharacters

    Character tokens used by the pure renderer.

    defaultValue?: string

    Initial active target for uncontrolled usage. Ignored when value is supplied.

    emptyText?: string

    Text displayed when no targets exist.

    focusedId?: string

    Preferred initial focus identifier.

    items: readonly TItem[]

    Ordered targets. Disabled targets are visible but not interactive.

    onValueChange?: (value: string) => void

    Called when Enter, Space, click, or NavigationListHandle.activateFocused selects.

    onFocusedIdChange?: (focusedId: string) => void

    Called after focus moves to a different enabled target.

    value?: string

    Controlled active target identifier.

    Settings

    Member Visibility

    On This Page

    Properties