CheckboxGroup

A checkbox group handles the spacing and orientation for a grouping of checkboxes, as well as providing a label.

View sourceView on npmReport an issue

Anatomy

Composed Components

A CheckboxGroup uses the following components:

Checkbox

A checkbox allows the user to select an option.

Usage

Read-only

A checkbox group can be read-only.

Disabled

A checkbox group can be disabled.

Invalid

A checkbox group can be invalid.

Sizes

A checkbox group can vary in size.

No Label

A checkbox group can be rendered without a label.

Description

A checkbox group can have a description to provide more information to the user.

Bordered

A checkbox group can be bordered.

Orientation

A checkbox group can have a different orientation.

Controlled

A checkbox group can handle value state in controlled mode.

Description on Items

A checkbox can have a description to provide more information to the user.

ContextualHelp

A ContextualHelp element may be placed next to the label to provide additional information or help about a CheckboxGroup.

Props

listProps?

The props of the list element that wraps the Checkbox components.

orientation?

A CheckboxGroup can be displayed horizontally or vertically.

Defaults to vertical.
variant?

A CheckboxGroup has two variants: borderless and bordered.

Defaults to borderless.
style?

The inline style for the element. A function may be provided to compute the style based on component state.

children?

The children of the component. A function may be provided to alter the children based on component state.

validationBehavior?

Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.

Defaults to 'native'.
value?

The current value (controlled).

defaultValue?

The default value (uncontrolled).

isDisabled?

Whether the input is disabled.

isReadOnly?

Whether the input can be selected but not changed by the user.

name?

The name of the input element, used when submitting an HTML form. See MDN.

isRequired?

Whether user input is required on the input before form submission.

isInvalid?

Whether the input value is invalid.

validate?

A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if validationBehavior="native". For realtime validation, use the isInvalid prop instead.

className?

The CSS className for the element. A function may be provided to compute the class based on component state.

UNSAFE_backgroundColor?

Sets the background-color property.

If you want to use a token value from the SCALE, use the backgroundColor property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_backgroundColorActive?

Sets the background-color property when active.

If you want to use a token value from the SCALE, use the backgroundColorActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_backgroundColorFocus?

Sets the background-color property when focused.

If you want to use a token value from the SCALE, use the backgroundColorFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_backgroundColorHover?

Sets the background-color property when hovered.

If you want to use a token value from the SCALE, use the backgroundColorHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_border?

Sets the border property.

If you want to use a token value from the SCALE, use the border property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderActive?

Sets the border property when active.

If you want to use a token value from the SCALE, use the borderActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottom?

Sets the border-bottom property.

If you want to use a token value from the SCALE, use the borderBottom property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomActive?

Sets the border-bottom property when active.

If you want to use a token value from the SCALE, use the borderBottomActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomFocus?

Sets the border-bottom property when focused.

If you want to use a token value from the SCALE, use the borderBottomFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomHover?

Sets the border-bottom property when hovered.

If you want to use a token value from the SCALE, use the borderBottomHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomLeftRadius?

Sets the border-bottom-left-radius property.

If you want to use a token value from the SCALE, use the borderBottomLeftRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderBottomRightRadius?

Sets the border-bottom-right-radius property.

If you want to use a token value from the SCALE, use the borderBottomRightRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderFocus?

Sets the border property when focused.

If you want to use a token value from the SCALE, use the borderFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderHover?

Sets the border property when hovered.

If you want to use a token value from the SCALE, use the borderHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderLeft?

Sets the border-left property.

If you want to use a token value from the SCALE, use the borderLeft property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderLeftActive?

Sets the border-left property when active.

If you want to use a token value from the SCALE, use the borderLeftActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderLeftFocus?

Sets the border-left property when focused.

If you want to use a token value from the SCALE, use the borderLeftFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderLeftHover?

Sets the border-left property when hovered.

If you want to use a token value from the SCALE, use the borderLeftHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRadius?

Sets the border-radius property.

If you want to use a token value from the SCALE, use the borderRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRight?

Sets the border-right property.

If you want to use a token value from the SCALE, use the borderRight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRightActive?

Sets the border-right property when active.

If you want to use a token value from the SCALE, use the borderRightActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRightFocus?

Sets the border-right property when focused.

If you want to use a token value from the SCALE, use the borderRightFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderRightHover?

Sets the border-right property when hovered.

If you want to use a token value from the SCALE, use the borderRightHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTop?

Sets the border-top property.

If you want to use a token value from the SCALE, use the borderTop property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopActive?

Sets the border-top property when active.

If you want to use a token value from the SCALE, use the borderTopActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopFocus?

Sets the border-top property when focused.

If you want to use a token value from the SCALE, use the borderTopFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopHover?

Sets the border-top property when hovered.

If you want to use a token value from the SCALE, use the borderTopHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopLeftRadius?

Sets the border-top-left-radius property.

If you want to use a token value from the SCALE, use the borderTopLeftRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_borderTopRightRadius?

Sets the border-top-right-radius property.

If you want to use a token value from the SCALE, use the borderTopRightRadius property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_boxShadow?

Sets the box-shadow property.

If you want to use a token value from the SCALE, use the boxShadow property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_boxShadowActive?

Sets the box-shadow property when active.

If you want to use a token value from the SCALE, use the boxShadowActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_boxShadowFocus?

Sets the box-shadow property when focused.

If you want to use a token value from the SCALE, use the boxShadowFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_boxShadowHover?

Sets the box-shadow property when hovered.

If you want to use a token value from the SCALE, use the boxShadowHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_color?

Sets the color property.

If you want to use a token value from the SCALE, use the color property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_colorActive?

Sets the color property when active.

If you want to use a token value from the SCALE, use the colorActive property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_colorFocus?

Sets the color property when focused.

If you want to use a token value from the SCALE, use the colorFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_colorHover?

Sets the color property when hovered.

If you want to use a token value from the SCALE, use the colorHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_columnGap?

Sets the column-gap property.

If you want to use a token value from the SCALE, use the columnGap property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fill?

Sets the fill property.

If you want to use a token value from the SCALE, use the fill property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fillFocus?

Sets the fill property when focused.

If you want to use a token value from the SCALE, use the fillFocus property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fillHover?

Sets the fill property when hovered.

If you want to use a token value from the SCALE, use the fillHover property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fontFamily?

Sets the font-family property.

If you want to use a token value from the SCALE, use the fontFamily property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fontSize?

Sets the font-size property.

If you want to use a token value from the SCALE, use the fontSize property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_fontWeight?

Sets the font-weight property.

If you want to use a token value from the SCALE, use the fontWeight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gap?

Sets the gap property.

If you want to use a token value from the SCALE, use the gap property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridAutoColumns?

Sets the grid-auto-columns property.

If you want to use a token value from the SCALE, use the gridAutoColumns property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridAutoRows?

Sets the grid-auto-rows property.

If you want to use a token value from the SCALE, use the gridAutoRows property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridColumnSpan?

Sets the grid-column-span property.

If you want to use a token value from the SCALE, use the gridColumnSpan property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridRowSpan?

Sets the grid-row-span property.

If you want to use a token value from the SCALE, use the gridRowSpan property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridTemplateColumns?

Sets the grid-template-columns property.

If you want to use a token value from the SCALE, use the gridTemplateColumns property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_gridTemplateRows?

Sets the grid-template-rows property.

If you want to use a token value from the SCALE, use the gridTemplateRows property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_height?

Sets the height property.

If you want to use a token value from the SCALE, use the height property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_lineHeight?

Sets the line-height property.

If you want to use a token value from the SCALE, use the lineHeight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_margin?

Sets the margin property.

If you want to use a token value from the SCALE, use the margin property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginBottom?

Sets the margin-bottom property.

If you want to use a token value from the SCALE, use the marginBottom property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginLeft?

Sets the margin-left property.

If you want to use a token value from the SCALE, use the marginLeft property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginRight?

Sets the margin-right property.

If you want to use a token value from the SCALE, use the marginRight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginTop?

Sets the margin-top property.

If you want to use a token value from the SCALE, use the marginTop property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginX?

Sets the horizontal margin (margin-left and margin-right) property.

If you want to use a token value from the SCALE, use the marginX property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_marginY?

Sets the vertical margin (margin-top and margin-bottom) property.

If you want to use a token value from the SCALE, use the marginY property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_maxHeight?

Sets the max-height property.

If you want to use a token value from the SCALE, use the maxHeight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_maxWidth?

Sets the max-width property.

If you want to use a token value from the SCALE, use the maxWidth property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_minHeight?

Sets the min-height property.

If you want to use a token value from the SCALE, use the minHeight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_minWidth?

Sets the min-width property.

If you want to use a token value from the SCALE, use the minWidth property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_padding?

Sets the padding property.

If you want to use a token value from the SCALE, use the padding property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingBottom?

Sets the padding-bottom property.

If you want to use a token value from the SCALE, use the paddingBottom property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingLeft?

Sets the padding-left property.

If you want to use a token value from the SCALE, use the paddingLeft property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingRight?

Sets the padding-right property.

If you want to use a token value from the SCALE, use the paddingRight property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingTop?

Sets the padding-top property.

If you want to use a token value from the SCALE, use the paddingTop property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingX?

Sets the horizontal padding (padding-left and padding-right) property.

If you want to use a token value from the SCALE, use the paddingX property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_paddingY?

Sets the vertical padding (padding-top and padding-bottom) property.

If you want to use a token value from the SCALE, use the paddingY property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_rowGap?

Sets the row-gap property.

If you want to use a token value from the SCALE, use the rowGap property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_stroke?

Sets the stroke property.

If you want to use a token value from the SCALE, use the stroke property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

UNSAFE_width?

Sets the width property.

If you want to use a token value from the SCALE, use the width property instead.

This property is marked as UNSAFE because you're opting out of the intended values of the design system.

description?

The helper message of the field.

errorMessage?

The error message of the field.

label?

The label of the field.

necessityIndicator?

Whether the required state should be shown as an asterisk or a label, which would display (Optional) on all non required field labels.

size?

A Field can vary in size.

Defaults to md.
contextualHelp?

A ContextualHelp element to place next to the label.

Migration Notes

Coming from Orbiter, you should be aware of the following changes:

  • onChange signature has been changed – no events are passed.
  • disabled has been renamed to isDisabled.
  • required has been renamed to isRequired.
  • fluid has been removed.
  • reverse is not supported, use flex-direction or row-reverse instead.
  • autofocus is not supported. You must put autofocus on the actual Checkbox.
  • The default orientation is now vertical instead of horizontal.
  • validationState is removed. use isInvalid instead. There is no isValid.
  • wrap is removed. If horizontal, radios will wrap.
  • There is no align prop. If needed, the styled system can be used.
  • The inline prop is not available.