A multi-checkbox component
Props
Name
Description
Type
Default
disabled
If the field is disabled.
booleanor
undefined
documentation
Inline documentation text.
stringor
undefined
documentationLink
Inline documentation link.
stringor
undefined
documentationLinkText
Inline documentation link text.
stringor
undefined
icon
The icon to use.
[namespace: stringor
symbol, name: string]or
string
[ICON_NAMESPACE, check]
invalid
If the field is currently invalid.
booleanor
undefined
label
The label of the field.
string
messages
The messages to display under the field.
ValidationMessagesor
undefined
name
The name of the field.
string
options
The list of options for the checkboxes.
MultiCheckboxOption[]
readonly
If the field is editable.
booleanor
undefined
templated
If the field is templated.
no-editor
booleanor
undefined
value
The current value of the field.
Set<string>
ValidationMessages
Name
Description
Type
MultiCheckboxOption
An option to be selected
Name
Description
Type
If the option is disabled.
A name to display.
The string to be used as a value.
Events
Event
Detail
Description
fieldchange
FieldChange<Set<string>, string>
Emitted when the value of the field is changed.
requestEdit
string
Emitted when the user requests to edit.
Parts
Name
Description
checkbox-field
Checkbox Field.