base-ui-svelte

Checkbox Group

A set of checkboxes for selecting multiple options.

View as Markdown
Apples

API Reference

Props mirror Base UI React where applicable, adapted for Svelte 5. Native HTML attributes for the rendered element are also accepted unless noted.

CheckboxGroup

Extends div HTML attributes.

PropertyTypeDefaultDescription
valuestring[] | undefinedControlled value.
defaultValuestring[]Uncontrolled initial value.
onValueChange((value: string[], event: Event) => void) | undefinedEvent handler called when the value changes.
disabledbooleanfalseWhether the control ignores user interaction.
allValuesstring[] | undefined
childrenSnippet<[{ value: string[]; disabled: boolean }]>Content rendered inside the part.
Data attributeDescription
data-disabledPresent when the part is disabled.