Mixins / foldkit-mixins-ui

CheckboxGroupView

interface · packages/mixins-ui/src/checkboxGroup.ts:36

interface CheckboxGroupView<Value extends string, Message> {
  readonly legend: string
  readonly options: ReadonlyArray<CheckboxGroupOption<Value>>
  readonly checked: ReadonlyArray<Value>
  readonly onToggle: (value: Value) => NoInfer<Message>
  readonly id: string
  readonly style?: NamedStyle<typeof CheckboxGroupSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

CheckboxGroupView.legend

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

readonly legend: string

What the options answer, the group's accessible name.

CheckboxGroupView.options

property · packages/mixins-ui/src/checkboxGroup.ts:39

readonly options: ReadonlyArray<CheckboxGroupOption<Value>>

CheckboxGroupView.checked

property · packages/mixins-ui/src/checkboxGroup.ts:41

readonly checked: ReadonlyArray<Value>

The checked values, as the application keeps them.

CheckboxGroupView.onToggle

property · packages/mixins-ui/src/checkboxGroup.ts:43

readonly onToggle: (value: Value) => NoInfer<Message>

The Message a press on an option sends; its type comes from h.

CheckboxGroupView.id

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

readonly id: string

Prefixes every id the group draws, unique on the page.

CheckboxGroupView.style

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

readonly style?: NamedStyle<typeof CheckboxGroupSlots> | undefined

A style of CheckboxGroupSlots, for the group's look.

CheckboxGroupView.mixins

property · packages/mixins-ui/src/checkboxGroup.ts:49

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.