blessed-components - v1.20.0
    Preparing search index...

    Interface RenderSwitchOptions

    Options accepted by renderSwitch.

    interface RenderSwitchOptions {
        checked?: boolean;
        characters?: SwitchCharacters;
        disabled?: boolean;
        focused?: boolean;
        label: string;
        offText?: string;
        onText?: string;
        width?: number;
    }
    Index

    Properties

    checked? characters? disabled? focused? label offText? onText? width?

    Properties

    checked?: boolean

    Current boolean state.

    characters?: SwitchCharacters

    Character tokens for on/off/disabled states.

    disabled?: boolean

    Whether focus and toggling are unavailable.

    focused?: boolean

    Whether the switch currently owns terminal focus.

    label: string

    Non-empty, single-line switch label.

    offText?: string

    Text rendered for the off state.

    'off'

    onText?: string

    Text rendered for the on state.

    'on'

    width?: number

    Maximum terminal-cell width of the rendered row.

    Settings

    Member Visibility

    On This Page

    Properties