Interface RenderActionBarOptions<TAction>

Options accepted by renderActionBar.

interface RenderActionBarOptions<
    TAction extends ActionBarAction = ActionBarAction,
> {
    actions: readonly TAction[];
    activeId?: string;
    characters?: ActionBarCharacters;
    pad?: boolean;
    width: number;
}

Type Parameters

TAction extends ActionBarAction = ActionBarAction

Index

Properties

actions activeId? characters? pad? width

Properties

actions

actions: readonly TAction[]

Ordered actions. Caller-owned data is never mutated.

`Optional`activeId

activeId?: string

Identifier receiving the visible focus marker.

`Optional`characters

characters?: ActionBarCharacters

Character tokens used to render state and separators.

`Optional`pad

pad?: boolean

Whether output is padded to exactly width cells.

Default Value

false

width

width: number

Available terminal-cell width.