Themes
Fields/Components/es-multi-checkbox
es-multi-checkbox

A multi-checkbox component

Props

Name
Description
Type
Default
disabled

If the field is disabled.

boolean
or
undefined
icon

The icon to use.

[namespace: string
or
symbol, name: string]
or
string
[ICON_NAMESPACE, check]
invalid

If the field is currently in an error state.

boolean
or
undefined
label

The label of the field.

string
messages

The validation messages of the field

ValidationMessages
or
undefined
name

The name of the field.

string
options

The list of options for the checkboxes.

MultiCheckboxOption[]
[]
readonly

If the field is editable.

boolean
or
undefined
value

The current value of the field.

Set<string>

ValidationMessages

Name
Description
Type
children
Record<number, Record<Severity, ValidationMessage[]>>
error
ValidationMessage[]
info
ValidationMessage[]
warning
ValidationMessage[]

MultiCheckboxOption

An option to be selected

Name
Description
Type
disabled

If the option is disabled.

boolean
name

A name to display.

string
value

The string to be used as a value.

string

Events

Event
Detail
Description
fieldchange
FieldChange<Set<string>>

Emitted when the value of the field is changed.

Parts

Name
Description
checkbox-field

Checkbox Field.