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

    Interface RenderNavigationListOptions<TItem>

    Options accepted by renderNavigationList.

    interface RenderNavigationListOptions<
        TItem extends NavigationListItem = NavigationListItem,
    > {
        activeId?: string;
        characters?: NavigationListCharacters;
        emptyText?: string;
        focusedId?: string;
        height: number;
        items: readonly TItem[];
        offset?: number;
        badgeSeparator?: string;
        width: number;
    }

    Type Parameters

    Index

    Properties

    activeId? characters? emptyText? focusedId? height items offset? badgeSeparator? width

    Properties

    activeId?: string

    Identifier rendered as the active route or view.

    characters?: NavigationListCharacters

    Character tokens used to communicate state without color.

    emptyText?: string

    Text returned when items is empty.

    'No destinations'

    focusedId?: string

    Identifier receiving the visible focus marker.

    height: number

    Maximum number of rendered rows.

    items: readonly TItem[]

    Ordered navigation targets. Caller-owned data is never mutated.

    offset?: number

    First rendered target index.

    0

    badgeSeparator?: string

    Text inserted between a label and badge.

    ' '

    width: number

    Maximum terminal-cell width of each row.

    Settings

    Member Visibility

    On This Page

    Properties