Components

CheckboxGroup

<CheckboxGroup {...CheckboxGroup.CheckboxGroupProps} />

CheckboxGroup form item

Type Definitions

CheckboxGroup

Properties:
Name Type Attributes Description
label string <optional>
A custom label for the input field
attributes CheckboxGroup.CheckboxGroupAttributes <optional>
Custom attributes for the form field
options Array.<CheckboxGroup.CheckboxGroupOption> <optional>
List of options

CheckboxGroupAttributes

Attributes for the CheckboxGroup component
Properties:
Name Type Attributes Description
name string The name of all child checkboxes
readOnly boolean <optional>
Whether the user can interact with checkboxes
required boolean <optional>
Whether or not the field one of the fields should be selected

CheckboxGroupOption

Properties:
Name Type Attributes Description
value string <optional>
Value of the checkbox field
id string <optional>
A custom id for the input field
label string <optional>
A human-readable label for the field

CheckboxGroupProps

CheckboxGroup properties
Properties:
Name Type Description
field CheckboxGroup The checkboxGroup field component
handleBlur function Optional callback to be invoked on input blur