form.select

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
placeholder:
collapse_placeholder:
visibility:
character_limit:

ComposerElementSpec

header

Override the header for this component.

buttons:
title:
progress:
milestones:
extra_buttons:

HeaderElementSpec

markdown

Override the bot Markdown mode for this component. Check the Markdown guide for more info.

null

list
bool
NoneType

select

Label shown to describe this field

"Select"

str

icon

Icon shown for this field

null

IconElementSpec
str
NoneType

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
list
NoneType

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
      timeout: 123
      trigger_when: ANY
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    quick_replies:
      - url: STRING
        javascript: STRING
        button_id: STRING
        context:
          STRING: ANY
        default: false
        disabled: false
        divider: false
        icon:
          url: STRING
          color: STRING
          path: STRING
        action: COMPONENT
        value: ANY
        result: ANY
        data:
          STRING: ANY
        magic: false
        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:
        length: 123
        error_text: STRING
    header:
      buttons:
        - url: STRING
          javascript: STRING
          button_id: STRING
          context:
            STRING: ANY
          default: false
          disabled: false
          divider: false
          icon:
            url: STRING
            color: STRING
            path: STRING
          action: COMPONENT
          value: ANY
          result: ANY
          data:
            STRING: ANY
          magic: false
          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:
        value: 123
        show_percent: false
      milestones:
        - text: STRING
          current: false
      extra_buttons:
        - url: STRING
          javascript: STRING
          button_id: STRING
          context:
            STRING: ANY
          default: false
          disabled: false
          divider: false
          icon:
            url: STRING
            color: STRING
            path: STRING
          action: COMPONENT
          value: ANY
          result: ANY
          data:
            STRING: ANY
          magic: false
          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
    custom: false
    search: false
    placeholder: STRING
    multi: false
    default:
      - item1
      - item2
    options:
      - text: STRING
        disabled: false
        value: ANY
    retries: 123
    error_message: STRING