Interface BoxData

Shared semantic style data accepted by themed Blessed adapters.

interface BoxData {
    capabilities?: Pick<TerminalCapabilities, "colorLevel">;
    backgroundTone?: keyof ThemeColors;
    borderTone?: keyof ThemeColors;
    foregroundTone?: keyof ThemeColors;
    theme?: Theme;
}

Index

Properties

capabilities? backgroundTone? borderTone? foregroundTone? theme?

Properties

`Optional`capabilities

capabilities?: Pick<TerminalCapabilities, "colorLevel">

Explicit color capability used for deterministic rendering.

`Optional`backgroundTone

backgroundTone?: keyof ThemeColors

Semantic background token.

Default Value

'background'

`Optional`borderTone

borderTone?: keyof ThemeColors

Semantic border token.

Default Value

'border'

`Optional`foregroundTone

foregroundTone?: keyof ThemeColors

Semantic foreground token.

Default Value

'foreground'

`Optional`theme

theme?: Theme

Semantic terminal theme.