Action List
The Action List component displays a list of related action items, enabling marketers to choose an action in context with immediate effect — for example, picking a personalization token to insert into a text field.
Action items can be filtered, grouped, and have various states (e.g. disabled, or selected).
Default
Copy Pug Copy HTML Open in playground Show code Hide codee-actionlist
<e-actionlist>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state" selected>
State
</e-actionlist-item>
<e-actionlist-item value="zip-code">
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile">
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist><e-actionlist>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state" selected>
State
</e-actionlist-item>
<e-actionlist-item value="zip-code">
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile">
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist>JavaScript Copy JavaScript
Variations
with groups Copy Pug Copy HTML Open in playground Show code Hide code
<e-actionlist>
<e-actionlist-group label="General Information">
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name" selected>
Last Name
</e-actionlist-item>
<e-actionlist-item value="email">
Email
</e-actionlist-item>
</e-actionlist-group>
<e-actionlist-group label="Personal Information">
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state">
State
</e-actionlist-item>
<e-actionlist-item value="zip-code" disabled>
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile">
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist-group>
</e-actionlist><e-actionlist>
<e-actionlist-group label="General Information">
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name" selected>
Last Name
</e-actionlist-item>
<e-actionlist-item value="email">
Email
</e-actionlist-item>
</e-actionlist-group>
<e-actionlist-group label="Personal Information">
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state">
State
</e-actionlist-item>
<e-actionlist-item value="zip-code" disabled>
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile">
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist-group>
</e-actionlist>JavaScript Copy JavaScript
Multiple selection Copy Pug Copy HTML Open in playground Show code Hide codemultiple
<e-actionlist multiple>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name" selected>
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state" selected>
State
</e-actionlist-item>
<e-actionlist-item value="zip-code">
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile" selected>
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist><e-actionlist multiple>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name" selected>
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state" selected>
State
</e-actionlist-item>
<e-actionlist-item value="zip-code">
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile" selected>
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist>JavaScript Copy JavaScript
Height Copy Pug Copy HTML Open in playground Show code Hide codeheight="200px"
<e-actionlist height="200px">
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state" selected>
State
</e-actionlist-item>
<e-actionlist-item value="zip-code">
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile">
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist><e-actionlist height="200px">
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state" selected>
State
</e-actionlist-item>
<e-actionlist-item value="zip-code">
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile">
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist>JavaScript Copy JavaScript
Disable min-width Copy Pug Copy HTML Open in playground Show code Hide codedisable-min-width
<div style="display: inline-block;">
<e-actionlist disable-min-width>
<e-actionlist-item value="1">
1
</e-actionlist-item>
<e-actionlist-item value="2">
2
</e-actionlist-item>
<e-actionlist-item value="3">
3
</e-actionlist-item>
<e-actionlist-item value="4">
4
</e-actionlist-item>
<e-actionlist-item value="5">
5
</e-actionlist-item>
</e-actionlist>
</div><div style="display: inline-block;">
<e-actionlist disable-min-width>
<e-actionlist-item value="1">
1
</e-actionlist-item>
<e-actionlist-item value="2">
2
</e-actionlist-item>
<e-actionlist-item value="3">
3
</e-actionlist-item>
<e-actionlist-item value="4">
4
</e-actionlist-item>
<e-actionlist-item value="5">
5
</e-actionlist-item>
</e-actionlist>
</div>JavaScript Copy JavaScript
Always show search Copy Pug Copy HTML Open in playground Show code Hide codealways-show-search
<e-actionlist always-show-search>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
</e-actionlist><e-actionlist always-show-search>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
</e-actionlist>JavaScript Copy JavaScript
Wihtout search Copy Pug Copy HTML Open in playground Show code Hide code[search-hidden]
<e-actionlist search-hidden>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state" selected>
State
</e-actionlist-item>
<e-actionlist-item value="zip-code">
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile">
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist><e-actionlist search-hidden>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
<e-actionlist-item value="address">
Address
</e-actionlist-item>
<e-actionlist-item value="city">
City
</e-actionlist-item>
<e-actionlist-item value="state" selected>
State
</e-actionlist-item>
<e-actionlist-item value="zip-code">
ZIP Code
</e-actionlist-item>
<e-actionlist-item value="phone">
Phone
</e-actionlist-item>
<e-actionlist-item value="mobile">
Mobile
</e-actionlist-item>
<e-actionlist-item value="first-name-of-partner">
First Name of Partner
</e-actionlist-item>
<e-actionlist-item value="anniversary">
Anniversary
</e-actionlist-item>
<e-actionlist-item value="fax">
Fax
</e-actionlist-item>
<e-actionlist-item value="date-of-birth">
Date of Birth
</e-actionlist-item>
</e-actionlist>JavaScript Copy JavaScript
Loading state Copy Pug Copy HTML Open in playground Show code Hide codeloading
<e-actionlist loading>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
</e-actionlist><e-actionlist loading>
<e-actionlist-item value="first-name">
First Name
</e-actionlist-item>
<e-actionlist-item value="last-name">
Last Name
</e-actionlist-item>
<e-actionlist-item value="email" disabled>
Email
</e-actionlist-item>
</e-actionlist>JavaScript Copy JavaScript
Empty state text Copy Pug Copy HTML Open in playground Show code Hide codeempty-state-text
<e-actionlist always-show-search empty-state-text="Sample text"></e-actionlist><e-actionlist always-show-search empty-state-text="Sample text"></e-actionlist>JavaScript Copy JavaScript
with options Copy Pug Copy HTML Open in playground Show code Hide codeoptions
<e-actionlist id="optionsExample"></e-actionlist><e-actionlist id="optionsExample"></e-actionlist>JavaScript Copy JavaScript
document.querySelector('#optionsExample').options = [
{ type: 'item', content: 'simple item 1', value: 'item1' },
{ type: 'group', label: 'group 1', items: [
{ type: 'item', content: 'item 1', value: 'group1item1' }
] },
{ type: 'group', label: 'group 2', items: [
{ type: 'item', content: 'item 1', value: 'group2item1' },
{ type: 'item', content: 'item 1', value: 'group2item1', selected: true }
] }
];
API Reference e-actionlist
Properties
| Name | Description | Type | Required | Default value |
|---|---|---|---|---|
| multiple | Actionlist handle multiple selection | boolean | false | |
| height | Defines component fixed height. It can be any CSS unit (px, % etc.) | string | auto | |
| max-height | Defines component maximum height. It can be any CSS unit (px, % etc.) | string | auto | |
| disable-min-width | Sets the min-width style of the component to 0 | boolean | false | |
| always-show-search | Show search input even if there's not more then 8 options | boolean | false | |
| search-hidden | If true, search will never appear | boolean | false | |
| autofocus | Focuses the search input, when it becomes visible | boolean | false | |
| loading | Shows a spinner instead of the content or the empty state | boolean | false | |
| items | Set actionlist items | [{ type: 'group', content: ' ', value: ' ' }, { type: 'option', content: ' ', value: ' ' }] | ||
| empty-state-text | String shown when the list is empty and no search keyword | string | false |
Events
| Event | Description | Returns |
|---|---|---|
change | Fires on item selection change. | {
detail: {
value: 'value'
}
},
or if it is a multiple actionlist:
{
detail: {
value: ['value1', 'value2']
}
} |
API Reference e-actionlist-item
Properties
| Name | Description | Type | Required | Default value |
|---|---|---|---|---|
| value | Defines the value of the item. | string | text inside the element | |
| selected | Defines the selected value in actionlist. | boolean | false | |
| disabled | Defines the disabled state of the item. | boolean | false |
API Reference e-actionlist-group
Properties
| Name | Description | Type | Required | Default value |
|---|---|---|---|---|
| label | Defines the group label. | string | "" |
Related components
SelectAction List
The Action List component displays a list of related action items, enabling marketers to choose an action in context with immediate effect. For example, picking a personalization token to insert into a text field.
Action items can be filtered, grouped, and have various states (e.g. disabled, or selected).
Structure
Action Lists consist of:
- Search field:
- In its empty state, the placeholder text suggests the ability to filter the list below.
- When a value is entered, a "clear" action icon is displayed. Clicking this clears the entered value.
- List of action items:
2.1. Group separator item (optional):
2.2. Action item:- Displays the name of the group. - Not actionable.- Displays the name of the action item. - Actionable by clicking or by keyboard highlighting. - Can have a disabled state, which turns the item not actionable. - Can have a selected state, for a currently active item, e.g. when the user is modifying a previously made selection.
Additional design attributes:
- Action List items should be sorted alphabetically by default.
- Action List items can only have two levels in hierarchy, i.e. groups cannot be in groups.
Best Practices
Action Lists should:
- Be in context: users should always know what happens when they select an action item. Context can be implicit (e.g. coming from the page layout or workflow) or explicit (e.g. the action item label describes the action itself).
- The effect of selecting an action item should be immediate, e.g. inserting a token, proceeding to a new step in the workflow.
Try to avoid:
- Don't put Action Lists in forms, as item actions should be immediate. For selecting values to be submitted later on, use Select instead.
- Don't put unrelated, out-of-context items in the same Action List.
Clarified Concepts
- Select: select a single item from a dropdown list to be submitted later on, usually as part of submitting a form.
- Multiselect: similar to Select, but users can select multiple items.
- Dropdown: clicking a dropdown button opens the legacy version of an action list.
Content Guidelines
- Action items should follow the same content guidelines as Buttons.