LabelledCheckboxGroup
Component | Source Code
extends Omit<FormGroupProps, “defaultValue” | “children”>, Omit<LabelledProps, “labelProps”>
Props Inheritance Hierarchy: Omit<FormGroupProps, “defaultValue” | “children”> & Omit<LabelledProps, “labelProps”>
A group of related checkbox inputs.
Can be controlled or uncontrolled. If you intend to control the component, you must provide
a value that’s not undefined.
Properties
Section titled “Properties”options: CheckboxOption[]
Section titled “options: CheckboxOption[]”defaultValue?: CheckboxGroupValue
Section titled “defaultValue?: CheckboxGroupValue”The default value for the checkbox group to have. This only has an effect when the component is uncontrolled. If you
want to default a controlled group, just set your value’s initial value to be your default.
error?: string
Section titled “error?: string”info?: string
Section titled “info?: string”inlineItems?: boolean
Section titled “inlineItems?: boolean”(Optional, defaults to false) Whether the items in the group should be inline.
If this is false, each item in the group will be on its own line.
label?: string
Section titled “label?: string”labelPosition?: LabelPosition
Section titled “labelPosition?: LabelPosition”What position the label text appears relative to the input.
labelProps?: Omit<DetailedHTMLProps<HTMLAttributes, HTMLLegendElement>, “ref”>
Section titled “labelProps?: Omit<DetailedHTMLProps<HTMLAttributes, HTMLLegendElement>, “ref”>”labelTextProps?: InlineTextProps
Section titled “labelTextProps?: InlineTextProps”onChangeSelection?: Function
Section titled “onChangeSelection?: Function”Handler for when the user attempts to change their selected items in the checkbox group.
value?: CheckboxGroupValue
Section titled “value?: CheckboxGroupValue”The value the group should have. This is an array of all the names of the checkboxes that are currently checked.