Checkbox List Item
@astryxdesign/core v0.7.1 · CheckboxListItem
Props
| Prop | Type | Default | Description |
|---|---|---|---|
label | string | — | Primary text for the row. It also names the checkbox, so no separate accessible name is needed. Required. |
value | string | — | Row identity, matched against the parent CheckboxList array. Required in collection mode. Leave it out for a standalone row. |
description | string | — | Secondary text below the label. It is also the checkbox description, read after the label. |
isChecked | CheckboxValue (boolean | 'indeterminate') | false | Checked state of a standalone row. Ignored while the parent CheckboxList has a value array. |
isDisabled | boolean | false | Disables this row. The row stays in place and stays readable; it cannot be toggled. |
isLoading | boolean | false | Loading for this row. The checkbox shows a spinner and the row cannot be toggled. In collection mode the parent list turns it on while the toggled value's changeAction is still running. |
Events
check(checked: boolean): fires with the next state of a standalone row. Ignored in collection mode, where the parent list reports the change through its ownchangeevent.
Slots
end: content after the label and description, such as a badge or a count.