Must be used with ba-filter
This component should not be used on its own. Always use it within ba-filter to ensure correct spacing and layout
This component is for when one, none or multiple options can be selected. If only one item at a time can be selected, use ba-filter-radio instead.
Always use the label
attribute to give a meaningful label to the field.
Further reading:
Code
Properties & Attributes
Property | Attribute | Description | Type | Default |
---|---|---|---|---|
checked
|
checked |
Whether the filter-checkbox is checked | boolean | undefined |
undefined |
label
(required)
|
label |
The label of the filter-checkbox | string |
undefined |
name
(required)
|
name |
The name of the filter | string |
undefined |
value
(required)
|
value |
The value of the filter-checkbox | string |
undefined |
Slots
Slot | Description | Permitted elements |
---|---|---|
Unnamed slot | Elements will render in the body of the component | <ba‑star‑rating> |
Parent components
ba-filter-checkbox can be slotted into:
Usage
See ba-toolbar for usage examples.