Element details
type: meya.form.component.select
class: SelectComponent
path: /meya/form/component/select.py
signature: select
Fields
field | description
| required | signature | default | type |
---|---|---|---|---|---|
spec | Override the original spec for this element. | ○ | ○ | null | Spec |
context | Send context data with this component's event. | ○ | ○ | {} | dict |
sensitive | Mark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled. | ○ | ○ | false | bool |
triggers | Activate these dynamic triggers when the component runs. Check the component triggers guide for more info. | ○ | ○ | [] | list |
quick_replies | List of buttons that the user can select for replies. | ○ | ○ | [] | list |
composer | ○ | ○ | focus: blur | ComposerElementSpec | |
header | Override the header for this component. | ○ | ○ | buttons: | HeaderElementSpec |
markdown | Override the bot Markdown mode for this component. Check the Markdown guide for more info. | ○ | ○ | null | list |
select | Label shown to describe this field | ○ | ◉ | "Select" | str |
icon | Icon shown for this field | ○ | ○ | null | IconElementSpec |
name | Name of the input element | ○ | ○ | "select" | str |
autocomplete | Autocomplete mode for this field | ○ | ○ | "off" | str |
no_results_text | Text shown when no matches were found via search | ○ | ○ | "No results" | str |
custom | Whether custom values can be entered | ○ | ○ | false | bool |
search | Whether the user can type to search the options | ○ | ○ | false | bool |
placeholder | ○ | ○ | null | str | |
multi | Whether multiple options can be selected | ○ | ○ | false | bool |
default | Default selected option (text) | ○ | ○ | null | str |
options | Options available for selection | ◉ | ○ | list | |
retries | Number of retries before flow continues with error | ○ | ○ | "inf" | Real |
error_message | Message shown if input is invalid | ○ | ○ | "Invalid value selected" | str |
Usage reference
Basic
triggers
keyword meya.form.component.select
steps
select STRING
options
text STRING
value ANY
Full
triggers
keyword meya.form.component.select
steps
spec
type STRING
data
STRING ANY
timeout123
trigger_when ANY
context
STRING ANY
sensitivefalse
triggers
type STRING
data
STRING ANY
timeout123
trigger_when ANY
quick_replies
url STRING
javascript STRING
button_id STRING
context
STRING ANY
defaultfalse
disabledfalse
dividerfalse
icon
url STRING
color STRING
path STRING
action COMPONENT
value ANY
result ANY
data
STRING ANY
magicfalse
type text|url|static|menu|divider|action|flow_next|component_next
menu
BUTTONELEMENTSPEC
text STRING
composer
focus file|image|text|blur
placeholder STRING
collapse_placeholder STRING
visibility collapse|hide|show
character_limit
length123
error_text STRING
header
buttons
url STRING
javascript STRING
button_id STRING
context
STRING ANY
defaultfalse
disabledfalse
dividerfalse
icon
url STRING
color STRING
path STRING
action COMPONENT
value ANY
result ANY
data
STRING ANY
magicfalse
type text|url|static|menu|divider|action|flow_next|component_next
menu
BUTTONELEMENTSPEC
text STRING
title
text STRING
icon
url STRING
color STRING
path STRING
progress
value123
show_percentfalse
milestones
text STRING
currentfalse
extra_buttons
url STRING
javascript STRING
button_id STRING
context
STRING ANY
defaultfalse
disabledfalse
dividerfalse
icon
url STRING
color STRING
path STRING
action COMPONENT
value ANY
result ANY
data
STRING ANY
magicfalse
type text|url|static|menu|divider|action|flow_next|component_next
menu
BUTTONELEMENTSPEC
text STRING
markdown
format|linkify|breaks|typographer
select STRING
icon
url STRING
color STRING
path STRING
name STRING
autocomplete STRING
no_results_text STRING
customfalse
searchfalse
placeholder STRING
multifalse
default
item1
item2
options
text STRING
disabledfalse
value ANY
retries123
error_message STRING