BwCheckboxGroup | bw-checkbox-group
Overview
Checkbox groups are form controls that contain a list of BwCheckboxOption's.
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
error | error | Shows an error icon. If a string is passed in, it will render the icon as a tooltip. Has no effect on form validation | any | undefined |
horizontal | horizontal | Checkboxes will be aligned horizontally | boolean | false |
label | label | Label that shows above the controls | string | undefined |
note | note | Informative text that shows below the control | string | undefined |
originalValue | original-value | The value the control will reset to. Defaults to the initial value if not set. | any | undefined |
pending | pending | Shows a loading indicator | boolean | false |
required | required | Makes the element required in forms and will show an error on submission | boolean | false |
success | success | Shows a success icon. Has no effect on form validation | boolean | false |
value | value | The currently selected value | any[] | [] |
Events
| Event | Description | Type |
|---|---|---|
valueChange | Emits the selected value whenever it changes | CustomEvent<any> |
Methods
checkValidity() => Promise<boolean>
Checks the validity of the checkbox group
Returns
Type: Promise<boolean>
getCustomError() => Promise<string>
Gets the custom validity message for the checkbox group
Returns
Type: Promise<string>
reportValidity() => Promise<boolean>
Reports the validity of the checkbox group
Returns
Type: Promise<boolean>
setCustomValidity(message: string | null) => Promise<void>
Sets a custom validity message for the checkbox group
Parameters
| Name | Type | Description |
|---|---|---|
message | string |
Returns
Type: Promise<void>
Slots
| Slot | Description |
|---|---|
| The content of the checkbox group | |
"label" | The label of the checkbox group |
"note" | The note of the checkbox group |
Shadow Parts
| Part | Description |
|---|---|
"horizontal-container" | The horizontal container of the checkbox group |
"status" | The status container of the checkbox group |
Dependencies
Depends on
Graph
© 2025 United Systems & Software - All Rights Reserved.