Interface HelpOverlayOptions<TItem>

Options accepted by the Blessed helpOverlay adapter.

interface HelpOverlayOptions<TItem extends KeymapHelpItem = KeymapHelpItem> {
    box?: HelpOverlayBoxOptions;
    data: HelpOverlayData<TItem>;
    parent: Node;
}

Type Parameters

TItem extends KeymapHelpItem = KeymapHelpItem

Index

Properties

box? data parent

Properties

`Optional`box

box?: HelpOverlayBoxOptions

Position, dimensions, style, and standard Blessed box settings.

data

data: HelpOverlayData<TItem>

Open state, query state, and shortcut data.

parent

parent: Node

Blessed screen or node receiving the created box.