# ControlGroup

**📖 Live documentation:** https://cds.coinbase.com/components/inputs/ControlGroup/

A layout component that arranges and manages a group of related controls, such as radio buttons, switches, or checkboxes.

## Import

```tsx
import { ControlGroup } from '@coinbase/cds-web/controls/ControlGroup'
```

## Examples

### Checkbox Cell Group

```tsx live
function CheckboxGroupExample() {
  const [selected, setSelected] = useState(['one', 'four']);
  return (
    <VStack gap={2}>
      <ControlGroup
        label={<Text font="headline">Checkbox Group</Text>}
        ControlComponent={CheckboxCell}
        value={selected}
        onChange={(e) => {
          const { value: checkboxValue, checked } = e.target;
          setSelected((prev) =>
            checked ? [...prev, checkboxValue] : prev.filter((v) => v !== checkboxValue),
          );
        }}
        options={[
          { value: 'one', title: 'Option 1', description: 'A description for the first option.' },
          { value: 'two', title: 'Option 2', description: 'A description for the second option.' },
          {
            value: 'three',
            title: 'Option 3',
            description: 'This option is disabled.',
            disabled: true,
          },
          {
            value: 'four',
            title: 'Option 4',
            description: 'This option is read-only.',
            readOnly: true,
          },
        ]}
      />
      <Text>Selected: {selected.join(', ')}</Text>
    </VStack>
  );
}
```

### Radio Cell Group

```tsx live
function RadioGroupExample() {
  const [selected, setSelected] = useState('one');
  return (
    <VStack gap={2}>
      <ControlGroup
        label={<Text font="headline">Radio Group</Text>}
        ControlComponent={RadioCell}
        value={selected}
        role="radiogroup"
        onChange={(e) => setSelected(e.target.value)}
        options={[
          { value: 'one', title: 'Option 1', description: 'A description for the first option.' },
          { value: 'two', title: 'Option 2', description: 'A description for the second option.' },
          {
            value: 'three',
            title: 'Option 3',
            description: 'This option is disabled.',
            disabled: true,
          },
          {
            value: 'four',
            title: 'Option 4',
            description: 'This option is read-only.',
            readOnly: true,
          },
        ]}
      />
      <Text>Selected: {selected}</Text>
    </VStack>
  );
}
```

### Checkbox

```tsx live
function CheckboxExample() {
  const [selected, setSelected] = useState(['one', 'four']);
  return (
    <VStack gap={2}>
      <ControlGroup
        label={<Text font="headline">Checkbox</Text>}
        ControlComponent={Checkbox}
        value={selected}
        onChange={(e) => {
          const { value: checkboxValue, checked } = e.target;
          setSelected((prev) =>
            checked ? [...prev, checkboxValue] : prev.filter((v) => v !== checkboxValue),
          );
        }}
        options={[
          { value: 'one', label: 'Option 1' },
          { value: 'two', label: 'Option 2' },
          { value: 'three', label: 'Option 3 (disabled)', disabled: true },
          { value: 'four', label: 'Option 4 (read-only)', readOnly: true },
        ]}
      />
      <Text>Selected: {selected.join(', ')}</Text>
    </VStack>
  );
}
```

### Radio

```tsx live
function RadioExample() {
  const [selected, setSelected] = useState('one');
  return (
    <VStack gap={2}>
      <ControlGroup
        label={<Text font="headline">Radio</Text>}
        ControlComponent={Radio}
        value={selected}
        role="radiogroup"
        onChange={(e) => setSelected(e.target.value)}
        options={[
          { value: 'one', label: 'Option 1' },
          { value: 'two', label: 'Option 2' },
          { value: 'three', label: 'Option 3 (disabled)', disabled: true },
          { value: 'four', label: 'Option 4 (read-only)', readOnly: true },
        ]}
      />
      <Text>Selected: {selected}</Text>
    </VStack>
  );
}
```

### Switch

```tsx live
function SwitchExample() {
  const [selected, setSelected] = useState(['one', 'four']);
  return (
    <VStack gap={2}>
      <ControlGroup
        label={<Text font="headline">Switch</Text>}
        ControlComponent={Switch}
        value={selected}
        onChange={(e) => {
          const { value: switchValue, checked } = e.target;
          setSelected((prev) =>
            checked ? [...prev, switchValue] : prev.filter((v) => v !== switchValue),
          );
        }}
        options={[
          { value: 'one', label: 'Option 1' },
          { value: 'two', label: 'Option 2' },
          { value: 'three', label: 'Option 3 (disabled)', disabled: true },
          { value: 'four', label: 'Option 4 (read-only)', readOnly: true },
        ]}
      />
      <Text>Selected: {selected.join(', ')}</Text>
    </VStack>
  );
}
```

### Custom Card Toggle

```tsx live
function CustomCardToggleExample() {
  // Custom component that works with ControlGroup
  const CustomCardToggle = ({ checked, onChange, disabled, label, value, ...props }) => {
    return (
      <Box
        as="label"
        background={checked ? 'bgPositive' : 'bgSecondary'}
        borderColor={checked ? 'bgPositive' : 'bgLineHeavy'}
        borderWidth={100}
        borderRadius={300}
        padding={3}
        cursor={disabled ? 'not-allowed' : 'pointer'}
        opacity={disabled ? 0.6 : 1}
        transition="all 0.2s ease"
        {...props}
      >
        <HStack gap={2} alignItems="center">
          <Box
            width={20}
            height={20}
            borderRadius={100}
            background={checked ? 'bg' : 'bgLineHeavy'}
            alignItems="center"
            justifyContent="center"
          >
            {checked && (
              <Text color="fgPositive" font="body">
                ✓
              </Text>
            )}
          </Box>
          <Text color={checked ? 'fgInverse' : 'fg'} font="body">
            {label}
          </Text>
        </HStack>
        <input
          type="checkbox"
          checked={checked}
          onChange={onChange}
          disabled={disabled}
          value={value}
          style={{ display: 'none' }}
        />
      </Box>
    );
  };

  const [selected, setSelected] = useState(['premium']);
  return (
    <VStack gap={2}>
      <ControlGroup
        label={<Text font="headline">Custom Card Toggle</Text>}
        ControlComponent={CustomCardToggle}
        value={selected}
        onChange={(e) => {
          const { value: toggleValue, checked } = e.target;
          setSelected((prev) =>
            checked ? [...prev, toggleValue] : prev.filter((v) => v !== toggleValue),
          );
        }}
        options={[
          { value: 'basic', label: 'Basic Plan' },
          { value: 'premium', label: 'Premium Plan' },
          { value: 'enterprise', label: 'Enterprise Plan' },
          { value: 'custom', label: 'Custom Plan (disabled)', disabled: true },
        ]}
      />
      <Text>Selected: {selected.join(', ')}</Text>
    </VStack>
  );
}
```

### Custom Radio Button

```tsx live
function CustomRadioButtonExample() {
  // Custom radio component with enhanced styling
  const CustomRadioButton = ({ checked, onChange, disabled, children, value, ...props }) => {
    return (
      <Box
        as="label"
        background={checked ? 'accentBoldBlue' : 'bg'}
        borderColor={checked ? 'accentBoldBlue' : 'bgLineHeavy'}
        borderWidth={200}
        borderRadius={200}
        padding={3}
        cursor={disabled ? 'not-allowed' : 'pointer'}
        opacity={disabled ? 0.6 : 1}
        transition="all 0.2s ease"
        {...props}
      >
        <HStack gap={3} alignItems="center">
          <Box
            width={24}
            height={24}
            borderRadius={1000}
            background={checked ? 'bg' : 'transparent'}
            borderWidth={checked ? 0 : 200}
            borderColor="bgLineHeavy"
            alignItems="center"
            justifyContent="center"
          >
            {checked && (
              <Box width={12} height={12} borderRadius={1000} background="accentBoldBlue" />
            )}
          </Box>
          <VStack gap={0} alignItems="flex-start">
            <Text color={checked ? 'fgInverse' : 'fg'} font="body">
              {children}
            </Text>
            <Text color={checked ? 'fgInverse' : 'fgMuted'} font="caption">
              {value === 'starter' && 'Perfect for beginners'}
              {value === 'professional' && 'For growing businesses'}
              {value === 'enterprise' && 'For large organizations'}
            </Text>
          </VStack>
        </HStack>
        <input
          type="radio"
          checked={checked}
          onChange={onChange}
          disabled={disabled}
          value={value}
          style={{ display: 'none' }}
        />
      </Box>
    );
  };

  const [selected, setSelected] = useState('professional');
  return (
    <VStack gap={2}>
      <ControlGroup
        label={<Text font="headline">Custom Radio Button</Text>}
        ControlComponent={CustomRadioButton}
        value={selected}
        role="radiogroup"
        onChange={(e) => setSelected(e.target.value)}
        options={[
          { value: 'starter', label: 'Starter' },
          { value: 'professional', label: 'Professional' },
          { value: 'enterprise', label: 'Enterprise' },
        ]}
      />
      <Text>Selected: {selected}</Text>
    </VStack>
  );
}
```

## Props

| Prop | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `ControlComponent` | `ComponentType<ControlComponentProps>` | Yes | `-` | The control component to render for each option. |
| `options` | `(ControlGroupOption<ControlComponentProps> & { value: ControlValue; })[]` | Yes | `-` | Control options for the group. |
| `value` | `string \| ControlValue[]` | Yes | `-` | Current selected value(s). Use a string for single-select (e.g., RadioGroup) and an array of strings for multi-select (e.g., CheckboxGroup). |
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
| `aspectRatio` | `ResponsiveProp<AspectRatio>` | No | `-` | - |
| `background` | `ResponsiveProp<Color>` | No | `-` | - |
| `borderBottomLeftRadius` | `ResponsiveProp<BorderRadius>` | No | `-` | - |
| `borderBottomRightRadius` | `ResponsiveProp<BorderRadius>` | No | `-` | - |
| `borderBottomWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `borderColor` | `ResponsiveProp<Color>` | No | `-` | - |
| `borderEndWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `borderRadius` | `ResponsiveProp<BorderRadius>` | No | `-` | - |
| `borderStartWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `borderTopLeftRadius` | `ResponsiveProp<BorderRadius>` | No | `-` | - |
| `borderTopRightRadius` | `ResponsiveProp<BorderRadius>` | No | `-` | - |
| `borderTopWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `borderWidth` | `ResponsiveProp<BorderWidth>` | No | `-` | - |
| `bordered` | `boolean` | No | `-` | Add a border around all sides of the box. |
| `borderedBottom` | `boolean` | No | `-` | Add a border to the bottom side of the box. |
| `borderedEnd` | `boolean` | No | `-` | Add a border to the trailing side of the box. |
| `borderedHorizontal` | `boolean` | No | `-` | Add a border to the leading and trailing sides of the box. |
| `borderedStart` | `boolean` | No | `-` | Add a border to the leading side of the box. |
| `borderedTop` | `boolean` | No | `-` | Add a border to the top side of the box. |
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
| `color` | `ResponsiveProp<Color>` | No | `-` | - |
| `columnGap` | `ResponsiveProp<Space>` | No | `-` | - |
| `dangerouslySetBackground` | `string` | No | `-` | - |
| `direction` | `horizontal \| vertical` | No | `-` | The direction of the group. |
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
| `elevation` | `ResponsiveProp<Elevation>` | No | `-` | - |
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
| `flexGrow` | `ResponsiveProp<FlexGrow>` | No | `-` | - |
| `flexShrink` | `ResponsiveProp<FlexShrink>` | No | `-` | - |
| `flexWrap` | `ResponsiveProp<nowrap \| wrap \| wrap-reverse>` | No | `-` | - |
| `font` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
| `fontFamily` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
| `fontSize` | `ResponsiveProp<FontSize \| inherit>` | No | `-` | - |
| `fontWeight` | `ResponsiveProp<FontWeight \| inherit>` | No | `-` | - |
| `gap` | `ResponsiveProp<Space>` | No | `-` | - |
| `grid` | `ResponsiveProp<Grid>` | No | `-` | - |
| `gridArea` | `ResponsiveProp<GridArea>` | No | `-` | - |
| `gridAutoColumns` | `ResponsiveProp<GridAutoColumns<string \| number>>` | No | `-` | - |
| `gridAutoFlow` | `ResponsiveProp<GridAutoFlow>` | No | `-` | - |
| `gridAutoRows` | `ResponsiveProp<GridAutoRows<string \| number>>` | No | `-` | - |
| `gridColumn` | `ResponsiveProp<GridColumn>` | No | `-` | - |
| `gridColumnEnd` | `ResponsiveProp<GridColumnEnd>` | No | `-` | - |
| `gridColumnStart` | `ResponsiveProp<GridColumnStart>` | No | `-` | - |
| `gridRow` | `ResponsiveProp<GridRow>` | No | `-` | - |
| `gridRowEnd` | `ResponsiveProp<GridRowEnd>` | No | `-` | - |
| `gridRowStart` | `ResponsiveProp<GridRowStart>` | No | `-` | - |
| `gridTemplate` | `ResponsiveProp<GridTemplate>` | No | `-` | - |
| `gridTemplateAreas` | `ResponsiveProp<GridTemplateAreas>` | No | `-` | - |
| `gridTemplateColumns` | `ResponsiveProp<GridTemplateColumns<string \| number>>` | No | `-` | - |
| `gridTemplateRows` | `ResponsiveProp<GridTemplateRows<string \| number>>` | No | `-` | - |
| `height` | `ResponsiveProp<Height<string \| number>>` | No | `-` | - |
| `justifyContent` | `ResponsiveProp<left \| right \| center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| space-between \| space-around \| space-evenly>` | No | `-` | - |
| `key` | `Key \| null` | No | `-` | - |
| `label` | `ReactNode` | No | `-` | Set a label for the group. |
| `left` | `ResponsiveProp<Left<string \| number>>` | No | `-` | - |
| `lineHeight` | `ResponsiveProp<LineHeight \| inherit>` | No | `-` | - |
| `margin` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginBottom` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginEnd` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginStart` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginTop` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginX` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `marginY` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
| `maxHeight` | `ResponsiveProp<MaxHeight<string \| number>>` | No | `-` | - |
| `maxWidth` | `ResponsiveProp<MaxWidth<string \| number>>` | No | `-` | - |
| `minHeight` | `ResponsiveProp<MinHeight<string \| number>>` | No | `-` | - |
| `minWidth` | `ResponsiveProp<MinWidth<string \| number>>` | No | `-` | - |
| `name` | `string` | No | `-` | The name of the group. |
| `onChange` | `((e: ChangeEvent<HTMLInputElement>) => void)` | No | `-` | Handle change events. |
| `opacity` | `ResponsiveProp<Opacity>` | No | `-` | - |
| `overflow` | `ResponsiveProp<hidden \| auto \| visible \| clip \| scroll>` | No | `-` | - |
| `padding` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingBottom` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingEnd` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingStart` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingTop` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingX` | `ResponsiveProp<Space>` | No | `-` | - |
| `paddingY` | `ResponsiveProp<Space>` | No | `-` | - |
| `pin` | `PinningDirection` | No | `-` | Direction in which to absolutely pin the box. |
| `position` | `ResponsiveProp<fixed \| static \| relative \| absolute \| sticky>` | No | `-` | - |
| `ref` | `RefObject<HTMLDivElement> \| ((instance: HTMLDivElement \| null) => void) \| null` | No | `-` | - |
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
| `role` | `group \| radiogroup` | No | `-` | The role for the group. Use radiogroup for radio buttons, group for other controls. |
| `rowGap` | `ResponsiveProp<Space>` | No | `-` | - |
| `style` | `CSSProperties` | No | `-` | - |
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
| `textAlign` | `ResponsiveProp<center \| start \| end \| justify>` | No | `-` | - |
| `textDecoration` | `ResponsiveProp<none \| underline \| overline \| line-through \| underline overline \| underline double>` | No | `-` | - |
| `textTransform` | `ResponsiveProp<capitalize \| lowercase \| none \| uppercase>` | No | `-` | - |
| `top` | `ResponsiveProp<Top<string \| number>>` | No | `-` | - |
| `transform` | `ResponsiveProp<Transform>` | No | `-` | - |
| `userSelect` | `ResponsiveProp<text \| none \| auto \| all>` | No | `-` | - |
| `visibility` | `ResponsiveProp<hidden \| visible>` | No | `-` | - |
| `width` | `ResponsiveProp<Width<string \| number>>` | No | `-` | - |
| `zIndex` | `ResponsiveProp<ZIndex>` | No | `-` | - |