Checkbox Group

A checkbox group lets users select multiple items from a list of options, offering flexible choices for enhanced user interaction and control.

If you are using Tailwind v4, please refer to the 2.x documentation. This documentation assumes you are using Tailwind v3.

Basic

A group of checkboxes that lets you select multiple options at once.

Settings

Installation

If you hit any issues, make sure you check out the installation guide here.

Composed Components

When you plug this component from the CLI, it autoloads all the composed components. No need to toss 'em in one at a time.

The Checkbox Group's decked out with several components to make it bangin'.

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

Import the components and use them as shown below, adapting the structure to fit each component.

Description

Add a description to the checkbox group using the description prop.

User PermissionsSelect the permissions you want to grant to the user.

Validation

The checkbox group is in an error state.

Settings

Indeterminate

The checkbox group is in an indeterminate state.

Controlled

Control the checkbox group value with the value prop.

Options
No values selected

Uncontrolled

Control the checkbox group value with the defaultValue prop.

Options

Disabled

Disable the entire checkbox group by passing the isDisabled prop.

Settings

Read Only

When you need just a read-only checkbox group, pass the isReadOnly prop.

<CheckboxGroup isReadOnly/>