Checkbox

<React.Fragment />

Checkbox group configuration

Use a CheckboxGroup component to group checkboxes. CheckboxGroup components can use the following props:

className (optional)

A CSS class name to pass to the component.

isSmall (optional)

Whether to use the ‘small’ radio button variant. Boolean.

Checkbox items configuration

Checkbox components have the following properties:

checked (optional)

Whether the checkbox should be checked on load.

hintText (optional)

Text to use for a checkbox's hint text.

id

Value to use for the checkbox's id attribute.

isExclusive (optional)

Whether this checkbox is an an exclusive checkbox (a ‘none’ option). Boolean.

isSmall (optional)

Whether to use the ‘small’ checkbox variant. Boolean. Alternatively you can set this on an ancestor CheckboxGroup component.

label

Text to use for the checkbox's associated label.

name (optional)

Value to use for the checkbox's name attribute. Will fall back to using the id prop if not provided.

onBlur (optional)

Function to fire in response to a blur event.

onChange (optional)

Function to fire in response to a change event.