GitHub

Reference machines

switchMachine

interface 2 type 3 function 1
interface Interfaces 2
interface switch/index.ts · L34

# CreateSwitchInput

Members

disabled?
optional disabled?: boolean

Construct the machine in the disabled state. Defaults to false.

initial?
optional initial?: boolean

Initial checked value. Defaults to false.

interface switch/index.ts · L23

# SwitchContext

Members

checked
checked: boolean

Whether the switch is currently on. Mirrored as aria-checked.

toggles
toggles: number

Number of user-initiated toggles since construction.

type Type Aliases 3
type switch/index.ts · L17

# SwitchEvent

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

All events the Switch machine can receive.

function Functions 1
function switch/index.ts · L98

# createSwitchMachine ( )

createSwitchMachine(input?): SwitchMachine

Construct a fresh Switch machine.

Parameters

input?
CreateSwitchInput = {}

Returns

SwitchMachine