Checkbox is a form component that shows a checkbox with it's label. Checkbox.Group is a component that makes it easier to handle group of checkboxes.

If you want to allow a user to select only one out of multiple options, use the Radio component.

Import

import { Checkbox } from '@contentful/f36-components';
// or
import { Checkbox } from '@contentful/f36-forms';

Examples

Using as a controlled input

Controlled components in React are those in which form data is handled by the component’s state.

For using the Checkbox as a controlled input, you need to:

  • Pass the isChecked property, with this property it will already be a controlled component;
  • Pass a onChange handler, so you can use it to update the value of isChecked;

Setting the isChecked will already define it as a controlled input.

Using as an uncontrolled input

Uncontrolled components are those for which the form data is handled by the DOM itself. “Uncontrolled” refers to the fact that these components are not controlled by React state.

You can use the Checkbox as an uncontrolled input, for that you can:

  • Set the defaultChecked property, it will ensure that the checked state can be altered normally.
  • Don't set the isChecked as it will make the input controlled.

Using with Group

We also provide the Checkbox.Group component that helps when using multiple checkboxes. You can pass some common properties on the Checkbox.Group level and they will be passed to the checkboxes inside the group.

  • spacing: This will set how much space should be between the inputs;
  • name: By setting this property on the Checkbox.Group level, you will set it automatically for all the checkboxes in the group;
  • defaultValue: This accepts an array that set the defaultChecked property for checkboxes which the value exists in the array;
  • value: Same as defaultValue but this one sets the isChecked property, making the checkbox group controlled;
  • onChange: Handler that will be executed when any checkbox inside the group receives the event of change.

Checkbox.Group is a recommended way of using Checkbox when using it within forms.

Checked or indeterminate

The Checkbox can be rendered as indeterminate or checked, with the isIndeterminate, and isChecked or defaultChecked properties. Note that providing the isChecked makes it a controlled input, requiring an onChange handler.

Disabled

The Checkbox can be rendered as disabled with the isDisabled property.

Content guidelines

  • Use direct, succinct copy that helps the user to successfully complete the form
  • Do not use punctuation for labels
  • Use sentence style caps (in which only the first word of a sentence or term is capitalized)

Accessibility

  • To ensure Checkbox meets accessibility standards, provide name and id;
  • When using Checkbox.Group it should be wrapped in a <FormControl as="fieldset"> and have a <FormControl.Label as="legend">.

Props (API reference)

Props Checkbox

Name

Type

Default

aria-label
string

Value to be set as aria-label if not passing a children

className
string

CSS class to be appended to the root element

defaultChecked
false
true

Defines initial checked state for an uncontrolled component

helpText
string

Optional text to be added as help text bellow the label

id
string

Sets the id of the input

inputProps
Partial<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>>

Additional props that are passed to the input element

isChecked
false
true

Defines if the element is checked, onChange will be required

isDisabled
false
true

Applies disabled styles

isIndeterminate
false
true

Defines if the state is indeterminate

isInvalid
false
true

Applies invalid styles

isRequired
false
true

Validate the input

label
string

name
string

Set the name of the input

onBlur
FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>

Allows to listen to an event when an element loses focus

onChange
ChangeEventHandler<HTMLInputElement>

Allows to listen to an input’s change in value

onFocus
FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>

Allows to listen to an event when an element get focused

onKeyDown
KeyboardEventHandler<HTMLInputElement | HTMLTextAreaElement>

Allows to listen to an event when a key is pressed

resize
"none"
"both"
"horizontal"
"vertical"

Sets whether an element is resizable, and if so, in which directions

testId
string

A [data-test-id] attribute used for testing purposes

value
string

Set the value of the input

willBlurOnEsc
false
true

Boolean property that allows to blur on escape

Props Group

Name

Type

Default

children
required
ReactNode

Elements that should be in the group

className
string

CSS class to be appended to the root element

defaultValue
string[]

Array of values of the checkboxes that should be checked for uncontrolled inputs

name
string

Name that will be assigned to all checkboxes inside the group, unless a different name is passed to the checkbox

onBlur
FocusEventHandler<HTMLInputElement>

Handler that will be triggered when any checkbox inside the group loses focus

onChange
ChangeEventHandler<HTMLInputElement>

Handler that will be triggered when any checkbox inside the group has their checked state changed

testId
string

A [data-test-id] attribute used for testing purposes

value
string[]

Array of values of the checkboxes that should be checked for controlled inputs