Interface CheckboxHandle

Imperative handle returned by checkbox.

interface CheckboxHandle {
    checked(): CheckboxState;
    focus(): void;
    toggle(): boolean;
    element: BoxElement;
    destroy(): void;
    setData(data: CheckboxData): void;
}

Hierarchy (View Summary)

BlessedComponentHandle<CheckboxData, blessed.Widgets.BoxElement>
- CheckboxHandle

Index

Properties

Methods

checked focus toggle destroy setData

Properties

`Readonly`element

element: BoxElement

Underlying Blessed element available for standard element operations.

Methods

checked

checked(): CheckboxState
Returns the current controlled or uncontrolled checked state.

Returns CheckboxState
- Defined in adapters/blessed/checkbox.ts:53

focus

focus(): void
Gives terminal focus to an enabled checkbox.

Returns void
- Defined in adapters/blessed/checkbox.ts:56

toggle

toggle(): boolean
Toggles an enabled checkbox and reports whether toggling occurred.

Returns boolean
- Defined in adapters/blessed/checkbox.ts:59

destroy

destroy(): void
Destroys and detaches the owned element without destroying its parent.

Returns void
Inherited from BlessedComponentHandle.destroy
- Defined in adapters/blessed/types.ts:23

setData

setData(data: CheckboxData): void
Re-renders component content using complete replacement data.

The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.
Parameters
- data: CheckboxData
Returns void
Inherited from BlessedComponentHandle.setData
- Defined in adapters/blessed/types.ts:31