form.select

Element details

type: meya.form.component.select
class: SelectComponent
path: /meya/form/component/select.py
signature: select

Fields

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.nullSpec
contextSend context data with this component's event.{}
dict
sensitiveMark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled.falsebool
triggersActivate these dynamic triggers when the component runs. Check the component triggers guide for more info.[]list
quick_repliesList of buttons that the user can select for replies.[]list
composerfocus: blur
placeholder:
collapse_placeholder:
visibility:
character_limit:
ComposerElementSpec
headerOverride the header for this component.buttons:
title:
progress:
milestones:
extra_buttons:
HeaderElementSpec
markdownOverride the bot Markdown mode for this component. Check the Markdown guide for more info.nulllist
bool
NoneType
selectLabel shown to describe this field"Select"str
iconIcon shown for this fieldnullIconElementSpec
str
NoneType
nameName of the input element"select"str
autocompleteAutocomplete mode for this field"off"str
no_results_textText shown when no matches were found via search"No results"str
customWhether custom values can be enteredfalsebool
searchWhether the user can type to search the optionsfalsebool
placeholdernullstr
multiWhether multiple options can be selectedfalsebool
defaultDefault selected option (text)nullstr
list
NoneType
optionsOptions available for selectionlist
retriesNumber of retries before flow continues with error"inf"Real
error_messageMessage 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