@kumiki/machines/radioGroup · API

interface Interfaces 3

interface radio-group/index.ts · L53

# CreateRadioGroupInput

Type Parameters

V

Members

defaultValue?: optional defaultValue?: V | null
disabled?: optional disabled?: boolean
items: items: readonly RadioItem<V>[]
navigation?: optional navigation?: "wrap" | "clamp"
Whether arrow navigation wraps (default) or clamps.

interface radio-group/index.ts · L39

# RadioGroupContext

Type Parameters

V

Members

focusedId: focusedId: string | null
items: items: readonly RadioItem<V>[]
value: value: V | null

interface radio-group/index.ts · L22

# RadioItem

Type Parameters

V

Members

disabled?: readonly optional disabled?: boolean
###### Overrides

CollectionItem.disabled
id: readonly id: string
###### Overrides

CollectionItem.id
label?: readonly optional label?: string
###### Overrides

CollectionItem.label
value: readonly value: V

type Type Aliases 3

type radio-group/index.ts · L29

# RadioGroupEvent

RadioGroupEvent<V> = { id: string; type: "SELECT"; } | { id: string; type: "FOCUS"; } | { type: "BLUR"; } | { direction: NavigateDirection; type: "NAVIGATE"; } | { type: "SET.VALUE"; value: V | null; } | { items: ReadonlyArray<RadioItem<V>>; type: "SET.ITEMS"; } | { type: "DISABLE"; } | { type: "ENABLE"; }

Type Parameters

V

type radio-group/index.ts · L47

# RadioGroupMachine

RadioGroupMachine<V> = Machine<RadioGroupContext<V>, RadioGroupEvent<V>, RadioGroupState>

Type Parameters

V

type radio-group/index.ts · L45

# RadioGroupState

RadioGroupState = "idle" | "disabled"

function Functions 1

function radio-group/index.ts · L87

# createRadioGroupMachine ( )

createRadioGroupMachine<V>(input): RadioGroupMachine<V>

Construct a fresh RadioGroup machine.

Type Parameters

V

Parameters

input: CreateRadioGroupInput<V>

Returns

RadioGroupMachine<V>