Mixins / foldkit-mixins-ui

RadioGroupView

interface · packages/mixins-ui/src/radioGroup/view.ts:23

interface RadioGroupView<Value extends string, Outer> {
  readonly model: UiRadioGroup.Model
  readonly onMessage: (message: UiRadioGroup.Message) => Outer
  readonly legend: string
  readonly hideLegend?: boolean | undefined
  readonly options: ReadonlyArray<RadioGroupRow<Value>>
  readonly value: Option.Option<Value>
  readonly orientation?: 'horizontal' | 'vertical' | undefined
  readonly disabled?: boolean | undefined
  readonly readOnly?: boolean | undefined
  readonly invalid?: boolean | undefined
  readonly error?: string | undefined
  readonly name?: string | undefined
  readonly style?: NamedStyle<typeof RadioGroupSlots> | undefined
  readonly mixins?: MixinList<Outer> | undefined
}

Members

RadioGroupView.model

property · packages/mixins-ui/src/radioGroup/view.ts:25

readonly model: UiRadioGroup.Model

The interaction state Bundles.RadioGroup placed, or upstream's init made.

RadioGroupView.onMessage

property · packages/mixins-ui/src/radioGroup/view.ts:26

readonly onMessage: (message: UiRadioGroup.Message) => Outer

RadioGroupView.legend

property · packages/mixins-ui/src/radioGroup/view.ts:28

readonly legend: string

What the options answer: the group's accessible name, drawn above it.

RadioGroupView.hideLegend

property · packages/mixins-ui/src/radioGroup/view.ts:30

readonly hideLegend?: boolean | undefined

Draws no visible legend; the name stays on the group.

RadioGroupView.options

property · packages/mixins-ui/src/radioGroup/view.ts:31

readonly options: ReadonlyArray<RadioGroupRow<Value>>

RadioGroupView.value

property · packages/mixins-ui/src/radioGroup/view.ts:33

readonly value: Option.Option<Value>

The chosen option's value: the application's, set from Selected in onOut.

RadioGroupView.orientation

property · packages/mixins-ui/src/radioGroup/view.ts:35

readonly orientation?: 'horizontal' | 'vertical' | undefined

Default vertical.

RadioGroupView.disabled

property · packages/mixins-ui/src/radioGroup/view.ts:36

readonly disabled?: boolean | undefined

RadioGroupView.readOnly

property · packages/mixins-ui/src/radioGroup/view.ts:38

readonly readOnly?: boolean | undefined

Keeps the group navigable and not selectable.

RadioGroupView.invalid

property · packages/mixins-ui/src/radioGroup/view.ts:40

readonly invalid?: boolean | undefined

The group is aria-invalid; an error implies it.

RadioGroupView.error

property · packages/mixins-ui/src/radioGroup/view.ts:42

readonly error?: string | undefined

Shown under the group, which it describes.

RadioGroupView.name

property · packages/mixins-ui/src/radioGroup/view.ts:44

readonly name?: string | undefined

Submitted under this name as the chosen value.

RadioGroupView.style

property · packages/mixins-ui/src/radioGroup/view.ts:45

readonly style?: NamedStyle<typeof RadioGroupSlots> | undefined

RadioGroupView.mixins

property · packages/mixins-ui/src/radioGroup/view.ts:47

readonly mixins?: MixinList<Outer> | undefined

Mixins beside the style: RadioGroup.readingKeys.