CheckboxView.id
property · packages/mixins-ui/src/checkbox/view.ts:19
readonly id: stringPrefixes the ids the checkbox draws, unique on the page.
Mixins / foldkit-mixins-ui
interface · packages/mixins-ui/src/checkbox/view.ts:17
interface CheckboxView<Outer> {
readonly id: string
readonly checked: boolean
readonly onToggle: (checked: boolean) => NoInfer<Outer>
readonly label: string
readonly description?: string | undefined
readonly position?: TogglePosition | undefined
readonly labelAside?: Html | undefined
readonly indeterminate?: boolean | undefined
readonly disabled?: boolean | undefined
readonly readOnly?: boolean | undefined
readonly invalid?: boolean | undefined
readonly name?: string | undefined
readonly value?: string | undefined
readonly style?: NamedStyle<typeof CheckboxSlots> | undefined
readonly mixins?: MixinList<Outer> | undefined
}CheckboxView.idproperty · packages/mixins-ui/src/checkbox/view.ts:19
readonly id: stringPrefixes the ids the checkbox draws, unique on the page.
CheckboxView.checkedproperty · packages/mixins-ui/src/checkbox/view.ts:21
readonly checked: booleanThe application's field.
CheckboxView.onToggleproperty · packages/mixins-ui/src/checkbox/view.ts:23
readonly onToggle: (checked: boolean) => NoInfer<Outer>Sent with the state a press leaves.
CheckboxView.labelproperty · packages/mixins-ui/src/checkbox/view.ts:25
readonly label: stringThe checkbox's accessible name, drawn beside it.
CheckboxView.descriptionproperty · packages/mixins-ui/src/checkbox/view.ts:27
readonly description?: string | undefinedA line under the label, which also describes the control.
CheckboxView.positionproperty · packages/mixins-ui/src/checkbox/view.ts:29
readonly position?: TogglePosition | undefinedend puts the words before the control. Default start.
CheckboxView.labelAsideproperty · packages/mixins-ui/src/checkbox/view.ts:31
readonly labelAside?: Html | undefinedDrawn beside the label: a badge, a hint with a Tooltip.
CheckboxView.indeterminateproperty · packages/mixins-ui/src/checkbox/view.ts:33
readonly indeterminate?: boolean | undefinedA dash: some of what this box stands for is chosen.
CheckboxView.disabledproperty · packages/mixins-ui/src/checkbox/view.ts:34
readonly disabled?: boolean | undefinedCheckboxView.readOnlyproperty · packages/mixins-ui/src/checkbox/view.ts:36
readonly readOnly?: boolean | undefinedShows the state and refuses a press.
CheckboxView.invalidproperty · packages/mixins-ui/src/checkbox/view.ts:38
readonly invalid?: boolean | undefinedThe box shows the error edge and says so to a screen reader.
CheckboxView.nameproperty · packages/mixins-ui/src/checkbox/view.ts:40
readonly name?: string | undefinedSubmitted under this name, as value while checked and empty otherwise.
CheckboxView.valueproperty · packages/mixins-ui/src/checkbox/view.ts:42
readonly value?: string | undefinedWhat a checked box submits. Default on.
CheckboxView.styleproperty · packages/mixins-ui/src/checkbox/view.ts:43
readonly style?: NamedStyle<typeof CheckboxSlots> | undefinedCheckboxView.mixinsproperty · packages/mixins-ui/src/checkbox/view.ts:44
readonly mixins?: MixinList<Outer> | undefined