On this page
Checkbox
Provides a checkbox with checked and indeterminate states.
Overview
Copy the source into your project. Import the parts that you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without a wrapper or replacement package.
Preview
Checkbox with label
Installation
Run the init command from your project root first. The CLI configures StyleX and installs shared files and dependencies.
Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. The CLI keeps existing files.
Usage
Use Checkbox with a visible label for an independent yes-or-no choice.
Use checked and onCheckedChange for controlled state, or defaultChecked for uncontrolled state. indeterminate represents a partially selected group.
Import from the local file installed by the CLI.
API reference
The generator reads the component TypeScript source. Only component and Base UI props appear below. The Required column shows whether you must supply a property. It does not mean you must use the component.