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

    Interface SwitchData

    Stateful data accepted by the Blessed switchControl adapter.

    interface SwitchData {
        checked?: boolean;
        characters?: SwitchCharacters;
        defaultChecked?: boolean;
        disabled?: boolean;
        label: string;
        offText?: string;
        onCheckedChange?: (checked: boolean) => void;
        onText?: string;
    }
    Index

    Properties

    checked? characters? defaultChecked? disabled? label offText? onCheckedChange? onText?

    Properties

    checked?: boolean

    Controlled checked state.

    characters?: SwitchCharacters

    Character tokens used by the pure renderer.

    defaultChecked?: boolean

    Initial checked state for uncontrolled usage.

    disabled?: boolean

    Whether focus and toggling are unavailable.

    label: string

    Non-empty, single-line switch label.

    offText?: string

    Text rendered for the off state.

    onCheckedChange?: (checked: boolean) => void

    Called after keyboard, mouse, or imperative toggling requests a state change.

    onText?: string

    Text rendered for the on state.

    Settings

    Member Visibility

    On This Page

    Properties