Skip to content
Forms

Checkbox

A toggle control for boolean values. Built on Base UI primitives with accessible keyboard support and animated check indicator.

Import

import { Checkbox } from "@mikenotthepope/substrateui"

With Label

API Reference

PropTypeDefaultDescription
checkedbooleanfalseThe controlled checked state of the checkbox.
onCheckedChange(checked: boolean) => voidCallback fired when the checked state changes.
disabledbooleanfalseWhen true, prevents interaction with the checkbox.
idstringThe id attribute, useful for associating with a label.