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

    Interface CheckboxData

    Stateful data accepted by the Blessed checkbox adapter.

    interface CheckboxData {
        checked?: CheckboxState;
        characters?: CheckboxCharacters;
        defaultChecked?: CheckboxState;
        disabled?: boolean;
        label: string;
        onCheckedChange?: (checked: boolean) => void;
    }
    Index

    Properties

    checked? characters? defaultChecked? disabled? label onCheckedChange?

    Properties

    checked?: CheckboxState

    Controlled checked state.

    characters?: CheckboxCharacters

    Character tokens used by the pure renderer.

    defaultChecked?: CheckboxState

    Initial checked state for uncontrolled usage.

    disabled?: boolean

    Whether focus and toggling are unavailable.

    label: string

    Non-empty, single-line checkbox label.

    onCheckedChange?: (checked: boolean) => void

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

    Settings

    Member Visibility

    On This Page

    Properties