Checkbox
An interactive input that allows users to toggle a selection on or off, often used for settings or multiple-choice selections.
Basic
A checkbox is a small box you can tick to select an option. It’s either on or off.
Installation
If you hit any issues, make sure you check out the installation guide here for more information.
Composed Components
When you install this component via the CLI, it automatically loads all composed components, so you don’t need to add them individually.
The Checkbox comes packed with several components to enhance functionality and provide a seamless experience.
Manual Installation
Make sure you also install the composed components and the required packages for the component to function properly.
Anatomy
Label Prop
You can add a label to the checkbox by passing the label
prop.
Description Prop
Add a description to the checkbox group by passing the description
prop.
Invalid
The checkbox is in an error state.
Indeterminate
The checkbox is in an indeterminate state.
Controlled
You can control the checkbox value by using the value
prop.
Uncontrolled
You can control the checkbox value by using the defaultValue
prop.
Disabled
The checkbox is disabled.