Interface RenderStatusBarOptions

Options accepted by renderStatusBar.

interface RenderStatusBarOptions {
    characters?: StatusBarCharacters;
    message?: string;
    items?: readonly StatusBarItem[];
    pad?: boolean;
    width: number;
}

Index

Properties

characters? message? items? pad? width

Properties

`Optional`characters

characters?: StatusBarCharacters

Character set used for separators.

Default Value

STATUS_BAR_UNICODE_CHARACTERS

`Optional`message

message?: string

Optional one-line message. When present, it is rendered after left items.

`Optional`items

items?: readonly StatusBarItem[]

Status items grouped into left, center, and right sections.

`Optional`pad

pad?: boolean

Whether the output is padded to exactly width cells.

Default Value

true

width

width: number

Available width in terminal cells.