Made by ScaleRadix Homepage
Scale UI Radix
DocumentationDocumentationComponents CatalogComponents CatalogPlayroomPlayroom
Radix PrimitivesFont Awesome Icons
Components

Checkbox Group

Set of interactive buttons where multiple options can be selected at a time.

View sourceReport an issueView in Catalog
<CheckboxGroup.Root defaultValue={['1']} name="example">

  <CheckboxGroup.Item value="1">Fun</CheckboxGroup.Item>

  <CheckboxGroup.Item value="2">Serious</CheckboxGroup.Item>

  <CheckboxGroup.Item value="3">Smart</CheckboxGroup.Item>

</CheckboxGroup.Root>

API Reference

This component is based on the div element and supports common margin props.

Root

Contains all the parts of a checkbox group.

PropTypeDefault
asChild
boolean
No default value
size
Responsive<"1" | "2" | "3">
"2"
variant
"classic" | "surface" | "soft"
"surface"
color
enum
No default value
highContrast
boolean
No default value

Item

An item in the group that can be checked.

Examples

Size

Use the size prop to control the checkbox size.

<Flex align="center" gap="2">

  <CheckboxGroup.Root size="1" defaultValue="1">

    <CheckboxGroup.Item value="1" />

  </CheckboxGroup.Root>



  <CheckboxGroup.Root size="2" defaultValue="1">

    <CheckboxGroup.Item value="1" />

  </CheckboxGroup.Root>



  <CheckboxGroup.Root size="3" defaultValue="1">

    <CheckboxGroup.Item value="1" />

  </CheckboxGroup.Root>

</Flex>

Variant

Use the variant prop to control the visual style of the checkboxes. Currently, we recommend using only the surface and soft variant following the ScaleUI Radix design system.

<Flex gap="2">

  <Flex direction="column" asChild gap="2">

    <CheckboxGroup.Root variant="surface" defaultValue="1">

      <CheckboxGroup.Item value="1" />

      <CheckboxGroup.Item value="2" />

    </CheckboxGroup.Root>

  </Flex>



  <Flex direction="column" asChild gap="2">

    <CheckboxGroup.Root variant="soft" defaultValue="1">

      <CheckboxGroup.Item value="1" />

      <CheckboxGroup.Item value="2" />

    </CheckboxGroup.Root>

  </Flex>

</Flex>

Alignment

Composing CheckboxGroup.Item within Text automatically centers it with the first line of text.

<Flex direction="column" gap="3">

  <CheckboxGroup.Root size="1" defaultValue="1">

    <Text as="label" size="2">

      <Flex gap="2">

        <CheckboxGroup.Item value="1" /> Default

      </Flex>

    </Text>



    <Text as="label" size="2">

      <Flex gap="2">

        <CheckboxGroup.Item value="2" /> Compact

      </Flex>

    </Text>

  </CheckboxGroup.Root>



  <CheckboxGroup.Root size="2" defaultValue="1">

    <Text as="label" size="3">

      <Flex gap="2">

        <CheckboxGroup.Item value="1" /> Default

      </Flex>

    </Text>



    <Text as="label" size="3">

      <Flex gap="2">

        <CheckboxGroup.Item value="2" /> Compact

      </Flex>

    </Text>

  </CheckboxGroup.Root>



  <CheckboxGroup.Root size="3" defaultValue="1">

    <Text as="label" size="4">

      <Flex gap="2">

        <CheckboxGroup.Item value="1" /> Default

      </Flex>

    </Text>



    <Text as="label" size="4">

      <Flex gap="2">

        <CheckboxGroup.Item value="2" /> Compact

      </Flex>

    </Text>

  </CheckboxGroup.Root>

</Flex>

It is automatically well-aligned with multi-line text too.

Disabled

Use the native disabled attribute to create a disabled checkbox.

<Flex direction="column" gap="2">

  <CheckboxGroup.Root defaultValue="2">

    <CheckboxGroup.Item value="1">Off</CheckboxGroup.Item>

    <CheckboxGroup.Item value="2">On</CheckboxGroup.Item>

  </CheckboxGroup.Root>



  <CheckboxGroup.Root defaultValue="2">

    <CheckboxGroup.Item value="1" disabled>

      Off

    </CheckboxGroup.Item>

    <CheckboxGroup.Item value="2" disabled>

      On

    </CheckboxGroup.Item>

  </CheckboxGroup.Root>

</Flex>
PreviousCheckbox
NextCheckbox Cards
Edit this page on GitHub.