Forms

Checkbox

Click to check or uncheck, like making a choice on a quiz, simple and straightforward for quick decisions.

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

Plug this component into the CLI, and it automatically loads all the included components. No need to add them individually.

The Checkbox comes packed with a variety of components to make it stand out.

Field

Field's a core piece every other component uses. It flexes reusable styles, showing up in inputs, labels, descriptions, and more.

Manual Installation

Sometimes, using the CLI is the way to go, so make sure you install the necessary dependencies for the components you want to use.

Anatomy

Label Prop

You can add a label to the checkbox by passing the label prop.

<Checkbox label="Enable Notifications" />

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.

You have disabled the option.

Uncontrolled

You can control the checkbox value by using the defaultValue prop.

Disabled

The checkbox is disabled.