Interface RenderCheckboxOptions

Options accepted by renderCheckbox.

interface RenderCheckboxOptions {
    checked?: CheckboxState;
    characters?: CheckboxCharacters;
    disabled?: boolean;
    focused?: boolean;
    label: string;
    width?: number;
}

Index

Properties

checked? characters? disabled? focused? label width?

Properties

`Optional`checked

checked?: CheckboxState

Current checked state.

`Optional`characters

characters?: CheckboxCharacters

Character tokens for each state.

`Optional`disabled

disabled?: boolean

Whether focus and toggling are unavailable.

`Optional`focused

focused?: boolean

Whether the checkbox currently owns terminal focus.

label

label: string

Non-empty, single-line checkbox label.

`Optional`width

width?: number

Maximum terminal-cell width of the rendered row.