multiple-choice-checklist
Overview
multiple-choice-checklist
allows users to select multiple options from a list.
Version compatibility
multiple-choice-checklist
was introduced in version 4.36.1 of the JourneyApps Container.
It was updated visually and the disabled
attribute was introduced in version 4.75.0 of the JourneyApps Runtime.
Basic Example
Standard Attributes
bind
bind
label
label
required
required
Advanced Attributes
align-content
align-content
align-label
align-label
checkbox-position
checkbox-position
Version compatibility
checkbox-position
was introduced in version 4.86.1 of the JourneyApps Runtime.
Optional
Type: left
| right
Default: left
Specify where the checkbox is positioned in the component (relative to the option label).
disabled
disabled
Version compatibility
disabled
was introduced in version 4.75.0 of the JourneyApps Runtime.
id
id
label-case
label-case
Version compatibility
label-case
was introduced in version 4.80.0 of the JourneyApps Runtime.
label-color
label-color
mode
mode
Version compatibility
mode
was introduced in version 4.83.0 of the JourneyApps Runtime.
Optional
Type: row
| column
Default: column
Configure the layout of the list of check box options. row
lists options horizontally; column
lists options vertically.
modifier-text
modifier-text
on-change
on-change
When using multiple-choice-integer
you can omit the key attribute on options. The array passed to the function assigned to on-change
will correspond to the key starting from 0.
E.g. [0, 2]
corresponds to first and third options.
show-if
and hide-if
show-if
and hide-if
Component Methods
The following component methods are available when an id
is assigned to the component and component.multipleChoiceChecklist({id:'my-id'})
is called from JS/TS:
clear
clear
Clear the selected option(s) of the multiple-choice-checklist
.
scrollIntoView
scrollIntoView
Programmatically scroll until the multiple-choice-checklist
is visible in the view.
selectItem
selectItem
Select an item by its label of the list of options of the multiple-choice-checklist
.
selectItemByIndex
selectItemByIndex
Select an item by its index of the list of options of the multiple-choice-checklist
. Note: Indexes begin at 1.
Last updated