switchAttachment

import { … } from '@kumiki/headless/switchAttachment'

interface 3 type 4 function 1

interface Interfaces 3

disabled?: optional disabled?: boolean
Construct the machine in the disabled state. Defaults to false.

###### Inherited from

CreateSwitchInput.disabled
id?: optional id?: string
initial?: optional initial?: boolean
Initial checked value. Defaults to false.

###### Inherited from

CreateSwitchInput.initial
onCheckedChange?: optional onCheckedChange?: (checked) => void
Called whenever the checked value changes via user interaction. Not called for controlled set() updates that came from the parent.

###### Parameters

###### checked

boolean

###### Returns

void

interface

checked: checked: boolean
Whether the switch is currently on. Mirrored as aria-checked.
toggles: toggles: number
Number of user-initiated toggles since construction.

checked: readonly checked: boolean
context: readonly context: Readonly<SwitchContext>
disabled: readonly disabled: boolean
id: readonly id: string
machine: readonly machine: SwitchMachine
root: readonly root: Attachment
state: readonly state: SwitchState
set(): set(checked): void
###### Parameters

###### checked

boolean

###### Returns

void
setDisabled(): setDisabled(disabled): void
###### Parameters

###### disabled

boolean

###### Returns

void
subscribe(): subscribe(listener): () => void
###### Parameters

###### listener

(snapshot) => void

###### Returns

() => void
toggle(): toggle(): void
###### Returns

void

type Type Aliases 4

Attachment = (node) => void | (() => void)

void | (() => void)

type

SwitchEvent = { type: "TOGGLE"; } | { checked: boolean; type: "SET"; } | { type: "DISABLE"; } | { type: "ENABLE"; }

All events the Switch machine can receive.

type

SwitchMachine = Machine<SwitchContext, SwitchEvent, SwitchState>

type

SwitchState = "off" | "on" | "disabled"

function Functions 1

createSwitch(options?): SwitchController

Create a Switch controller plus its {@attach}-compatible root attachment.

SwitchController