StellarUI

<stellar-checkbox-group>

Properties

Preview

Markup

Copy

<stellar-checkbox-group

  label="Things for the cats"
  description="Select as few or as many as you'd like."
>
  <stellar-checkbox label="Catnip" value="catnip"></stellar-checkbox>
  <stellar-checkbox label="Food" value="food"></stellar-checkbox>
  <stellar-switch label="Treats" value="treats"></stellar-switch>
</stellar-checkbox-group>

API

Complete props, events, slots, and implementation notes for the shipped checkbox group.

Props

Prop	Type	Default
`label`	`string`	`''`
`description`	`string`	`''`
`orientation`	`vertical \| horizontal`	`horizontal`
`required`	`boolean`	`false`

Events

Event	Source	Notes
custom events	none	`stellar-checkbox-group` does not emit custom events.
descendant events	native	Listen to grouped `stellar-checkbox` or `stellar-switch` children normally.

Slots

Slot	Notes
default	Grouped `stellar-checkbox` or `stellar-switch` children.
`label`	Optional rich label content. Overrides the `label` prop when present.
`description`	Optional helper content below the label. Overrides the `description` prop when present.

Notes

The public tag is `stellar-checkbox-group`, matching the shipped checkbox-group wrapper instead of inventing a second selection model.
It stays structural: the group owns shared label and description semantics, while slotted `stellar-checkbox` or `stellar-switch` children keep their own checked state and form behavior.
`required` only adds the visual required marker on the group label. Actual validity still belongs to descendant checkboxes or switches.
`orientation` controls whether slotted items wrap horizontally or stack vertically.
The wrapper does not intercept descendant events, so listen for `change` on the grouped controls normally.