Checkbox

Children to render in the checkbox group

A string or elements to be placed on the legend

If true, visually hides the legend element but it will still be available to screen readers

Controls the orientation that the CheckboxGroup's children are rendered in.

Flag to indicate that each Checkbox in the CheckboxGroup is in an invalid state

The status message to be displayed. Will only be displayed if aria-invalid is true

The id of the input field

A string or elements to be placed on the label

The checked state of the checkbox

Flag to use the component in an uncontrolled setting

Flag to indicate that the field is in a warning state

The string representing the value of the checkbox

The name of the checkbox

ID of element providing further context and description of the link

The event handler for change events on the input field

Props to be spread onto the element

Props to be spread onto the <IconCheck> component

The status message to be displayed. Will only be displayed if aria-invalid is true

@deprecated use aria-disabled instead.

The disabled prop removes the element from the Accessibility Tree and prevents it from receiving focus. This is not recommended.

All DLS components are designed to use the aria-disabled property instead, which will style the component to be disabled, but still allow keyboard focus and screen reader interactivity.

If true, styles component as disabled and prevents interactivity. Screen reader reads as "dimmed" or "disabled".

identifies the element (or elements) whose contents or presence are controlled

The checked state of the indeterminate checkbox (controlled)

The default checked state of the Indeterminate Checkbox (uncontrolled component).

Flag to indicate whether the checkbox is in an indeterminate state

The event handler for click events on the indeterminate checkbox

A string or elements to be placed on the label

The id of the input field

If true, styles component as disabled and prevents interactivity. Screen reader reads as "dimmed" or "disabled".

Flag to indicate that the field is in a warning state

The string representing the value of the checkbox

The name of the checkbox

@deprecated use aria-disabled instead.

The disabled prop removes the element from the Accessibility Tree and prevents it from receiving focus. This is not recommended.

All DLS components are designed to use the aria-disabled property instead, which will style the component to be disabled, but still allow keyboard focus and screen reader interactivity.