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

    Interface RenderMenuBarOptions<TItem>

    Options accepted by renderMenuBar.

    interface RenderMenuBarOptions<TItem extends MenuBarItem = MenuBarItem> {
        activeId?: string;
        characters?: MenuBarCharacters;
        emptyText?: string;
        focusedId?: string;
        items: readonly TItem[];
        separator?: string;
        width: number;
    }

    Type Parameters

    Index

    Properties

    activeId? characters? emptyText? focusedId? items separator? width

    Properties

    activeId?: string

    Identifier rendered as active or open.

    characters?: MenuBarCharacters

    Character tokens for focus, active, and disabled state.

    emptyText?: string

    Text returned when items is empty.

    'No menus'

    focusedId?: string

    Identifier rendered with a focus marker.

    items: readonly TItem[]

    Ordered top-level menus. Caller-owned data is never mutated.

    separator?: string

    Text inserted between top-level menus.

    ' '

    width: number

    Maximum terminal-cell width of the rendered line.

    Settings

    Member Visibility

    On This Page

    Properties