Skip to content

Checkbox Group

<bh-checkbox-group> | BharatCheckboxGroup

The Checkbox Group component allows users to select multiple options with full control over size, layout, and validation. It consists of a group container and child checkbox options.

Basic Usage

Orientation

Required Validation

Disabled State

Properties

<bh-checkbox-group> | BharatCheckboxGroup

PropertyTypeDescription
labelstringGroup label
valuesarraySelected values
orientationstring"vertical" (default) or "horizontal"
sizestring"small", "medium", or "large"
requiredbooleanEnforce validation for selection
disabledbooleanDisables the entire group
labelColorstringTweak the label color of the Checkbox group
checkboxColorstringTweak the checkbox color for the entire group
optionTextColorstringTweak the checkbox-option label color for entire group color

<bh-checkbox-option> | BharatCheckboxOption

PropertyTypeDescription
valuestringOption value
checkedbooleanWhether the checkbox is selected
disabledbooleanDisable individual option
colorstringChange color of individual option
textColorstringChange color of individual option label

Events


EventFired byDescription
checkbox-selected<bh-checkbox-option>Emits { value, checked } on toggle
change<bh-checkbox-group>Emits { label, values } when selection changes