Interface RenderDividerOptions

Options accepted by renderDivider.

interface RenderDividerOptions {
    characters?: DividerCharacters;
    label?: string;
    labelAlign?: DividerLabelAlign;
    length: number;
    orientation?: DividerOrientation;
}

Index

Properties

characters? label? labelAlign? length orientation?

Properties

`Optional`characters

characters?: DividerCharacters

Drawing characters.

Default Value

{ horizontal: '─', vertical: '│' }

`Optional`label

label?: string

Optional label embedded in a horizontal Divider.

`Optional`labelAlign

labelAlign?: DividerLabelAlign

Horizontal label placement.

Default Value

'center'

length

length: number

Total terminal cells or rows occupied by the Divider.

`Optional`orientation

orientation?: DividerOrientation

Divider direction.

Default Value

'horizontal'