Checkbox
A box for one independent yes/no choice, with indeterminate state and form submission built in.
Paste this into your agent.
Checkbox covers agreements, opt-ins and single options that are checked or not and submit with a form. It is also the option inside a Checkbox Group.
Install
bashnpx shadcn@4.18.0 add @siteplane/checkbox
Import it from @/siteplane/components/checkbox. The project needs Siteplane UI's one-time setup first: .
When to pick it
- vs : Pick Switch for a setting that takes effect on change, like enabling notifications.
- vs : Pick Checkbox Group when several related options share one name and selection.
- vs : Pick Radio Group when exactly one option of a set must be chosen.
- vs : Pick Toggle for a pressed tool state in a toolbar. Checkbox holds a form value.
Rules
- Wrap the box and its text in
FieldLabelorLabelso clicking the text toggles it. - Use
checkedwithonCheckedChangeonly when the app owns the value. Otherwise usedefaultChecked. - Set
uncheckedValuewhen the server needs a value for the unchecked state. Without it, an unchecked box sends nothing. aria-invalidonly styles the box. Field and FieldError carry the error itself.- Use
Label variant="card"for card-style options instead of rebuilding checked styles.
Reference
Add to your agent
Print this skill from the terminal, or connect the whole catalog over MCP. Setup guides
CLI
MCP server
Questions
Related skills
Siteplane Checkbox Groupby UI Skillbook
Holds a set of related checkboxes as one array value, with an optional parent box that selects all.
Siteplane UI
Siteplane Date Fieldby UI Skillbook
A typed date input built from day, month and year segments, with an optional calendar popover.
Siteplane UI
Siteplane Fieldby UI Skillbook
Ties a control to its label, help text and validation messages, with top or floating labels.
Siteplane UI
Siteplane Fieldsetby UI Skillbook
Groups related form fields under a shared legend and optional description, and can disable them together.
Siteplane UI