Skip to main content

Checkbox


Standalone checkbox component, meant to be used to build custom selection components (for example, a selectable card).

Since it has no label, users must pass either aria-label or aria-labelledby in order to preserve accessibility.

Example

Selectable cardLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
<Card>
<Box
padding={24}
background={checked ? "softOrange" : "backgroundPrimary"}
onClick={toggleChecked}
cursor={{
default: "pointer",
disabled: "notAllowed",
}}
>
<Columns space={16}>
<Column width="content">
<Checkbox
aria-label="Toggle card selection"
value={checked}
onChange={toggleChecked}
/>
</Column>
<Stack space={8}>
<Title size="medium">Selectable card</Title>
<Body size="medium">
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
minim veniam, quis nostrud exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat. Duis aute irure dolor in
reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.
</Body>
</Stack>
</Columns>
</Box>
</Card>

Props

NameTypeDefault ValueRequiredDescription
disabledbooleanNo
valuebooleanYes
onChange(value: boolean) => unknownYes

Related components