Class LabeledToggle

Index

Constructors

Properties

wrapper input changeHandler

Methods

setChecked isChecked setVisible setInert getInertReason dispose

Constructors

constructor

new LabeledToggle(options: LabeledToggleOptions): LabeledToggle
Parameters
- options: LabeledToggleOptions
Returns LabeledToggle
- Defined in src/ui/layers/labeled-toggle.ts:27

Properties

`Private` `Readonly`wrapper

wrapper: HTMLElement

`Private` `Readonly`input

input: HTMLInputElement

`Private` `Readonly`changeHandler

changeHandler: () => void

Methods

setChecked

setChecked(checked: boolean): void
Programmatically set the state. Does not fire onChange.
Parameters
- checked: boolean
Returns void
- Defined in src/ui/layers/labeled-toggle.ts:53

isChecked

isChecked(): boolean
The current state.

Returns boolean
- Defined in src/ui/layers/labeled-toggle.ts:58

setVisible

setVisible(visible: boolean): void
Show/hide the whole control group.
Parameters
- visible: boolean
Returns void
- Defined in src/ui/layers/labeled-toggle.ts:63

setInert

setInert(reason: string | null): void
Mark the toggle INERT — flipping it changes nothing in the current state of its siblings (refracting data needs a transmitting surface). Disabled, dimmed, with the reason as hover text; null restores the live state. Same contract as LabeledSlider.setInert.
Parameters
- reason: string | null
Returns void
- Defined in src/ui/layers/labeled-toggle.ts:73

getInertReason

getInertReason(): string | null
The hover text of the whole group (the inert reason, or empty).

Returns string | null
- Defined in src/ui/layers/labeled-toggle.ts:80

dispose

dispose(): void
Remove from DOM and detach listeners.

Returns void
- Defined in src/ui/layers/labeled-toggle.ts:85