Interface RenderFooterBarOptions

Options accepted by renderFooterBar.

interface RenderFooterBarOptions {
    characters?: FooterBarCharacters;
    context?: string;
    message?: string;
    pad?: boolean;
    shortcuts?: readonly FooterBarShortcut[];
    tone?: FooterBarTone;
    width: number;
}

Index

Properties

characters? context? message? pad? shortcuts? tone? width

Properties

`Optional`characters

characters?: FooterBarCharacters

`Optional`context

context?: string

Persistent application context shown before the message.

`Optional`message

message?: string

Current or transient application message.

`Optional`pad

pad?: boolean

Whether output is padded to exactly width.

Default Value

true

`Optional`shortcuts

shortcuts?: readonly FooterBarShortcut[]

`Optional`tone

tone?: FooterBarTone

Semantic marker for message.

width

width: number