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

    Interface RenderDropdownMenuOptions<TAction>

    Options accepted by renderDropdownMenu.

    interface RenderDropdownMenuOptions<TAction extends MenuItem = MenuItem> {
        activeItemId?: string;
        characters?: DropdownMenuCharacters;
        emptyText?: string;
        focusedId?: string;
        height: number;
        items: readonly DropdownMenuItem<TAction>[];
        menuHeight?: number;
        menuOffset?: number;
        openId?: string;
        separator?: string;
        shortcutSeparator?: string;
        width: number;
    }

    Type Parameters

    Index

    Properties

    activeItemId? characters? emptyText? focusedId? height items menuHeight? menuOffset? openId? separator? shortcutSeparator? width

    Properties

    activeItemId?: string

    Identifier receiving the visible focused action marker inside open menu.

    characters?: DropdownMenuCharacters

    Character tokens for menu bar and menu rows.

    emptyText?: string

    Text returned when no top-level menus exist.

    focusedId?: string

    Identifier receiving top-level focus marker.

    height: number

    Maximum rendered rows. First row is always menu bar.

    items: readonly DropdownMenuItem<TAction>[]

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

    menuHeight?: number

    Maximum open dropdown rows. Defaults to remaining height.

    menuOffset?: number

    First rendered dropdown action index.

    openId?: string

    Open top-level menu identifier.

    separator?: string

    Text inserted between top-level menus.

    shortcutSeparator?: string

    Text inserted between action label and shortcut.

    width: number

    Maximum terminal-cell width of each row.

    Settings

    Member Visibility

    On This Page

    Properties