Forms & Input
Checkbox
Native checkbox with custom indicator, checked / indeterminate, onCheckedChange, Field integration — shadcn-aligned examples. Make the expected input clear before someone interacts, and keep the current value, help text and validation feedback connected. Import it from @/components/kamod-ui/checkbox.
Source · Design reference · API reference · Theming · Styles
Interactive preview
Preact example Local preview theme · Responsive styles follow the preview widthFull widthInstallation
Import Checkbox from @/components/kamod-ui/checkbox.
pnpm add @kamod-ch/uiCopy an example with @kamod-ch/ui or the matching @kamod-ch/ui/… subpath. The code block switches between those two installs. Connect The Global Theme CSS and Tailwind Source Detection before your first render.
Usage
Use defaultChecked or checked with onCheckedChange. checked may be true, false, or "indeterminate".
import { Checkbox } from "@kamod-ch/ui";Choose a complete composition from the examples below; required child components and props vary by pattern.
Component Examples & Variants
Explore Checkbox in Different Contexts, from the starting pattern to the compositions below. Begin with Demo, then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API Reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.
Read the Result and Its Implementation Together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the Component Styles Guide for hierarchy and the Theming Guide for shared surfaces and colors. The Accessibility Notes explain what to preserve when making those changes.
Demo
Compose several independent choices with Field, including a description and a disabled option.
// See hero previewCode — Field + Checkbox + FieldContent / FieldTitle.Checked State
Pass checked and onCheckedChange when another part of the screen needs the same boolean.
Interactive preview
Preact example Local preview theme · Responsive styles follow the preview widthFull widthIndeterminate
Use checked="indeterminate" for a mixed group, and decide what activating it does to the children.
Interactive preview
Preact example Local preview theme · Responsive styles follow the preview widthFull widthInvalid
Set data-invalid on Field and aria-invalid on Checkbox so the error reaches the control.
Interactive preview
Preact example Local preview theme · Responsive styles follow the preview widthFull widthGroup
Name the set with FieldSet and FieldLegend. Each choice keeps its own label, unlike Radio Group.
Interactive preview
Preact example Local preview theme · Responsive styles follow the preview widthFull widthTable
Derive the header checkbox from selected row ids, and decide whether select-all covers this page or the whole set.
Interactive preview
Preact example Local preview theme · Responsive styles follow the preview widthFull widthProps and Data
Configure Checkbox using the contracts below. Read the documented options alongside the Source Definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.
Props, slots and variants for this component.
Type cards are extracted from this checkout’s TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.
Component Props
? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.Checkbox
CheckboxProps
| Prop / type | Description |
|---|---|
checked | Configure
|
class | Configure
|
defaultChecked | Configure
|
disabled | Configure
|
id | Configure
|
onChange | Configure
|
onCheckedChange | Configure
|
ref | Configure
|
Data Type Reference
Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the Implementation Source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.
CheckboxCheckedState
DeclarationCheckboxCheckedStateCheckbox.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of CheckboxCheckedState before adapting it.Checkbox Props
4 declared fieldsCheckboxPropsCheckbox.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions. Inspect the Complete Definition of CheckboxProps before adapting it.Accessibility
Build the Complete Interaction, Including the Parts Outside Checkbox. The notes below distinguish the current implementation from the labels, content and behavior your application supplies. Start with the Live Preview, check the Props and Data Reference, and test the finished composition with real content rather than assuming that an unchanged visual example covers every use case.
Built-in Behavior and Defaults
Checkbox uses a native checkbox input with a visual indicator. Its mixed state is exposed as aria-checked="mixed". The indicator is decorative; the underlying input remains the focusable, labelable control.
Labels and Relationships
Associate the option text through an ID and visible label, or provide an accessible name for a compact table-selection control. Name a select-all checkbox by its scope, such as Select all visible invoices, rather than simply Select all.
Keyboard and Focus
Use Space to toggle after keyboard focus reaches the input. For a parent checkbox, calculate checked, unchecked and indeterminate from the actual child selections. The application decides what activating a mixed parent does; keep that decision consistent.
States and Integration Details
Do not use mixed state merely to mean unavailable. Disabled and indeterminate describe different things. If the checkbox governs dependent fields, explain that relationship and avoid unexpectedly moving focus when the options appear.
Verify the Complete Interaction
Check Behavior as Well as Markup. Work through these scenarios in the application where the component will be used. Automated checks can help find structural problems; also review the reading experience with a screen reader, keyboard focus and the actual feedback from your application.
- Test unchecked, checked, mixed and disabled states using the keyboard and a screen reader.
- Select some child rows, activate the parent, then filter the list and recheck its selection scope.
- Click the text label and confirm it toggles exactly once without a duplicate wrapper handler.
Recheck the result after changing Theme Tokens, translations or class overrides. Include text enlargement, narrow layouts and reduced-motion settings where animation is present. Inspect the Component Source when a behavior differs from your expectation; a role or state attribute does not implement keyboard interaction by itself.
For background, read the WAI-ARIA Authoring Guidance and Keyboard Interface Guidance. These explain the patterns; verify browser and assistive-technology behavior for the implementation and audience you actually support.
You have the pieces. Put them into one real interaction, keep its state in one place, and check the result with the content your application will actually show.
Connect the Foundation
Return to Choose and Compose Components to connect this reference to a working screen. Keep global CSS in one entrypoint and import only the components that screen needs.
Build the Surrounding Screen
Find a neighboring interaction in the Component Library, or start with a complete Block. Replace sample content and destinations before refining the layout; a local class change can stay with the composition.
Make the Result Hold Up
Use shared theme roles for changes that belong everywhere. Then review the whole journey: keyboard focus, long labels, narrow screens and a clear way to recover when something fails.
Keep a link to the source and note your intentional changes. Your next edit should begin with a clear decision, not another search.