Forms
Checkbox group
Coordinates related checkbox values and parent selection.
idle
Usage
Examples
Delivery preferences
Select individual channels or enable them together.
Digest schedule
Recommendations
| Guidance | Practice |
|---|---|
| Do | Give the group a shared label and each option a distinct value. Use parent selection for an explicit select-all task. |
| Do | Set allValues when using the parent checkbox so it can derive mixed state. |
Usage boundaries
| Guidance | Boundary |
|---|---|
| Scope | The group coordinates selected values. The application decides how those values affect records or permissions. |
API reference
Public props from @mizen-labs/ui. Use exported prop types for the complete TypeScript contract.
| Prop | Type | Default | Description |
|---|---|---|---|
| | — | Controls the selected checkbox values. |
| | — | Sets initial selected values. |
| | — | Receives selected-value changes. |
| | false | Prevents interaction across the group. |