Forms
CheckboxGroup
Groups related checkbox choices under one legend.
01
See it and copy it
Framework example
Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.
Framework usage
Switch targets to compare the adapter code. The preview stays visually stable because all three packages share the same tokens andui-* class contract.---
import { Checkbox, CheckboxGroup } from '@santi020k/lumen-astro'
---
<CheckboxGroup legend="Notifications">
<label><Checkbox name="alerts" value="product" /> Product alerts</label>
<label><Checkbox name="alerts" value="billing" /> Billing updates</label>
</CheckboxGroup>import { Checkbox, CheckboxGroup } from '@santi020k/lumen-react'
export const Example = () => (
<>
<CheckboxGroup legend="Notifications">
<label><Checkbox name="alerts" defaultValue="product" /> Product alerts</label>
<label><Checkbox name="alerts" defaultValue="billing" /> Billing updates</label>
</CheckboxGroup>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-checkbox-group legend="Notifications">
<label><lumen-checkbox name="alerts" value="product"></lumen-checkbox> Product alerts</label>
<label><lumen-checkbox name="alerts" value="billing"></lumen-checkbox> Billing updates</label>
</lumen-checkbox-group>02
Choose your target
Add this component
Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.
pnpm add @santi020k/lumen-astropnpm add @santi020k/lumen-astrolumen add CheckboxGrouplumen add CheckboxGrouppnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add CheckboxGroup --target reactlumen add CheckboxGroup --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add CheckboxGroup --target elementslumen add CheckboxGroup --target elementsAPI reference
Lumen-specific props and runtime attributes for the Astro primitive. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.
| Attribute | Values | Default | Description |
|---|---|---|---|
| legend | string | - | Adds the visible fieldset legend for the related checkbox choices. |
| orientation | "horizontal" | "vertical" | "vertical" | Controls the visual arrangement without changing fieldset semantics. |
| invalid | boolean | false | Marks the group invalid for validation feedback. |
| class, className | string | "" | Merges custom classes with the generated ui-* root classes. |
| ...native attributes | HTML attributes | - | Forwards standard attributes to the root element unless the component consumes them. |