Pluma
About
MCP Server
Getting started
Contributing
Breaking Changes
Changelog
Content
Icons
Motion
Style Utilities
Test Helpers
Tokens
Overview
Status
Accordion
AccordionGroup
Box
Card
CenterBaseline
Divider
EmptyState
Flex
FormLayout
Grid
InlineStack
Panel
Scrollable
Stack
Code
DescriptionList
Emphasis
Heading
List
Paragraph
Strong
Text
TextLabel
Truncated
Avatar
CodeBlock
Coin
Icon
Image
LabelIcon
Breadcrumbs
Link
NavItem
Page
Pagination
PlainLink
SideNav
Tabs
TabNav
Button
ButtonGroup
CloseButton
DropdownMenu
PlainButton
ToggleButton
Checkbox
CheckboxGroup
ColorPicker
Combobox
DatePicker
Form
JsonField
NumberField
OptionCard
OptionCardGroup
Radio
RadioGroup
Search
SegmentedControl
Select
Slider
TextArea
TextField
Toggle
Badge
DataTable
Filters
FormattedDateTime
FormattedRelativeTime
KeyboardShortcut
Label
ProgressBar
ProgressCircle
StatusIndicator
Table
Tag
Banner
PageLoader
SkeletonShape
SkeletonText
Snackbar
Spinner
Blanket
ConfirmationModal
Drawer
Modal
Modal manager
Popover
Tooltip
VisuallyHidden
Anti-patterns
Combobox with Add New
Density
Inline Form Controls
Refinement levers
Search with DropdownMenu
States
Voice
Ember Floating UI
Ember prop spreading
ModalPrimitive
PlumaProvider
PopoverPrimitive
Portal
React Yield
fly-alert
fly-badge
fly-btn
fly-card
fly-close
fly-label
fly-panel
fly-progress
fly-range
fly-spinner
fly-tag
Forms
Lists
Tailwind
Componentsv2.170.1
Iconsv1.15.0
MCPv0.8.18
Tokensv0.34.1

CheckboxGroup

Figma
Github
Storybook
Aria patternLegacy component

The CheckboxGroup component is used for displaying a list of related options, in the form of Checkbox inputs, where multiple choices may be selected.

Importing

In a React app, the component can be imported via:

import { CheckboxGroup } from '@customerio/pluma-components/react';

In an Ember app, the component is named PlumaCheckboxGroup.

Usage

A CheckboxGroup should contain Checkbox components as children. CheckboxGroup will forward the name attribute to any Checkboxes nested within, as well as connect onChange handlers to them, so there's no need to define those props on the Checkboxes themselves:

Test checkbox group
import { CheckboxGroup, Checkbox } from '@customerio/pluma-components/react';
import { useState } from 'react';

export default function Example() {
  const [value, setValue] = useState(['one']);

  return (
    <CheckboxGroup
      label="Test checkbox group"
      value={value}
      onChange={(value) => {
        setValue(value);
      }}
    >
      <Checkbox value="one" label="One" />
      <Checkbox value="two" label="Two" />
      <Checkbox value="three" label="Three" />
    </CheckboxGroup>
  );
}

Or, in Ember:

Loading...

Labels

A CheckboxGroup must always have an associated label. The component accepts a label string prop, which renders text above the nested checkboxes.

Alternatively, ariaLabelledby may be used to associate the group with a label elsewhere in the DOM. To make sure the association is set up both ways, it's recommended to also set for on the label, pointing to an id on the checkbox group:

import { Box, CheckboxGroup, Checkbox } from '@customerio/pluma-components/react';
import { useState } from 'react';

export default function Example() {
  const [value, setValue] = useState([]);

  return (
    <Box>
      <Box as="label" id="my_label_id" htmlFor="my_group">
        Make a selection
      </Box>
      <CheckboxGroup
        id="my_group"
        ariaLabelledby="my_label_id"
        value={value}
        onChange={(value) => {
          setValue(value);
        }}
      >
        <Checkbox value="one" label="One" />
        <Checkbox value="two" label="Two" />
        <Checkbox value="three" label="Three" />
      </CheckboxGroup>
    </Box>
  );
}

Finally, the ariaLabel prop can be used if no other element is suitable for a label.

Disabled groups

The isDisabled prop on a CheckboxGroup will take precedence over the isDisabled prop on individual Checkbox components.

It is not necessary to set isDisabled on the individual Checkbox components, as the CheckboxGroup provides that state to the Checkboxes through its context.

Test checkbox group
import { Box, CheckboxGroup, Checkbox } from '@customerio/pluma-components/react';
import { useState } from 'react';

export default function Example() {
  const [isDisabled, setIsDisabled] = useState(false);
  const [value, setValue] = useState([]);

  return (
    <Box>
      <Box as="label" mb="200" display="block">
        <Checkbox
          label="Disable group"
          isChecked={isDisabled}
          onChange={(e) => {
            setIsDisabled(e.target.checked);
          }}
        />
      </Box>
      <CheckboxGroup
        label="Test checkbox group"
        isDisabled={isDisabled}
        value={value}
        onChange={(value) => {
          setValue(value);
        }}
      >
        <Checkbox value="one" label="One" isDisabled={false} />
        <Checkbox value="two" label="Two" isDisabled={false} />
        <Checkbox value="three" label="Three" isDisabled={true} />
      </CheckboxGroup>
    </Box>
  );
}

API

PlumaCheckboxGroup extends Box

ariaLabel  string | undefined

The aria-label attribute to be applied on the fieldset

ariaLabelledby  string | undefined

The aria-labelledby attribute to be applied on the fieldset

id  string | undefined

An optional id attribute to assign to the fieldset

isDisabled  boolean | undefined

Whether the entire group is disabled

label  string | undefined

The label text to be shown above the checkbox group

name  string | undefined

The name shared by checkboxes in this group. If none is provided, one will be generated

value  string[] | null | undefined

An array of the currently selected values

On this page

Importing
Usage
Labels
Disabled groups
API