single-choice-dropdown

Overview

Version compatibility

• single-choice-dropdown is supported in all versions of the JourneyApps Container and Runtime.

• It received several functional updates in version 4.84.0 of the JourneyApps Runtime.

A single-choice-dropdown component allows users to make a single selection from a pre-defined set of options in a dropdown component.

Basic Example

main.view.xml

<var name="selected_country" type="single-choice">
    <option key="us">USA</option>
    <option key="uk">UK</option>
    <option key="de">Germany</option>
    ...
</var>

<single-choice-dropdown label="Country of residence" bind="selected_country" required="false" />

Standard Attributes

bind

pagebind

label

pagelabel

required

pagerequired

Advanced Attributes

align-content

Version compatibility

align-content was introduced in version 4.84.0 of the JourneyApps Runtime.

pagealign-content

align-dialog-content

Optional

Type: center | left | right

Default: center

Version compatibility

align-dialog-content was introduced in version 4.84.0 of the JourneyApps Runtime.

Specifies how the content of the list of options dialog should be aligned. This includes the display value of each option, as well as the header text of the dialog.

<single-choice-dropdown label="Country of residence" align-dialog-content="left" bind="selected_country" />

align-label

pagealign-label

clear-button-visibility

pageclear-button-visibility

dialog-title

Optional

Type: string (static text, a format string or the return value of a JS/TS function)

Default: "Choose an option"

Version compatibility

dialog-title was introduced in version 4.84.0 of the JourneyApps Runtime.

Header text of the dialog that displays the list of options of the single-choice-dropdown.

<single-choice-dropdown label="Country of residence" dialog-title="Choose the country of residence" bind="selected_country" />

disabled

pagedisabled

empty-message

Version compatibility

empty-message was introduced in version 4.84.0 of the JourneyApps Runtime.

Optional

Type: string (static text, a format string or the return value of a JS/TS function)

Default: unset

Text that is displayed if no options are available to list once the user opens the single-choice-dropdown.

<single-choice-dropdown label="Country of residence" bind="selected_country" empty-message="No countries are available. Please contact your administrator." />

icon-position

Version compatibility

icon-position was introduced in version 4.86.1 of the JourneyApps Runtime.

pageicon-position

id

pageid

label-case

Version compatibility

label-case was introduced in version 4.84.0 of the JourneyApps Runtime.

pagelabel-case

label-color

pagelabel-color

modifier-text

Version compatibility

modifier-text was introduced in version 4.84.0 of the JourneyApps Run

pagemodifier-text

on-change

pageon-change

placeholder

pageplaceholder

search-controls

Optional

Type: auto | none | show

Default: auto

Version compatibility

search-controls was introduced in version 4.84.0 of the JourneyApps Runtime.

Set the visibility of the search box of the single-choice-dropdown component. auto shows the search box when the list of options contains 12 options or more. none never shows the search box, and show always shows the search box at the top of the list of options.

<single-choice-dropdown label="Country of residence" bind="selected_country" search-controls="show" />

show-if and hide-if

pageshow-ifpagehide-if

Component Methods

The following component methods are available when an id is assigned to the component and component.singleChoiceDropdown({id:'my-id'}) is called from JS/TS:

clear

Programmatically clear the selected value bound to the single-choice-dropdown.

clearSearch

Programmatically clear a value entered into the search box.

openDropdown

Programmatically open the list of items.

closeDropdown

Programmatically close the list of items.

scrollDown

Programmatically scroll down the list of items when the single-choice-dropdown is opened.

scrollIntoView

Programmatically scroll until the single-choice-dropdown is visible in the view.

scrollUp

Programmatically scroll up the list of items when the single-choice-dropdown is opened.

selectItem

Programmatically select an item from the list by its label.

main.view.xml

<var name="favorite_color" type="single-choice">
    <option key="green">Green</option>
    <option key="red">Red</option>
    <option key="yellow">Yellow</option>
</var>

<single-choice-dropdown id="my-dropdown" bind="favorite_color" label="Favorite Color" />

main.js

function select() {
    component.singleChoiceDropdown({id: 'my-dropdown'}).openDropdown(); // Need to open the dropdown first
    component.singleChoiceDropdown({id: 'my-dropdown'}).selectItem('Yellow');
}

selectItemByIndex

Programmatically select an item from the list by its index. Note: Indexes begin at 1.

main.view.xml

<var name="favorite_color" type="single-choice">
    <option key="green">Green</option>
    <option key="red">Red</option>
    <option key="yellow">Yellow</option>
</var>

<single-choice-dropdown id="my-dropdown" bind="favorite_color" label="Favorite Color" />

main.js

function select() {
    component.singleChoiceDropdown({id: 'my-dropdown'}).openDropdown(); // Need to open the dropdown first
    component.singleChoiceDropdown({id: 'my-dropdown'}).selectItemByIndex(2);
    // Selects "Red"
}

setSearch

Programmatically enter a search value and triggers a search of the single-choice-dropdown.