form.select

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

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

context

dict

{}

Send context data with this component's event

sensitive

bool

false

Mark this component's event as sensitive

triggers

list

[]

Activate these dynamic triggers when the component runs

quick_replies

list

[]

List of buttons that the user can select for replies

composer

ComposerElementSpec

focus: blur
placeholder:
visibility:

markdown

list
bool
NoneType

null

Override the bot Markdown mode for this component

select

str

"Select"

Label shown to describe this field

icon

IconElementSpec
str
NoneType

null

Icon shown for this field

name

str

"select"

Name of the input element

autocomplete

str

"off"

Autocomplete mode for this field

no_results_text

str

"No results"

Text shown when no matches were found via search

custom

bool

false

Whether custom values can be entered

search

bool

false

Whether the user can type to search the options

placeholder

str

null

multi

bool

false

Whether multiple options can be selected

default

str
list
NoneType

null

Default selected option (text)

options

list

Options available for selection

retries

Real

"inf"

Number of retries before flow continues with error

error_message

str

"Invalid value selected"

Message shown if input is invalid

Examples

Basic

triggers:
  - keyword: meya.form.component.select
steps:
  - select: STRING
    options:
      - text: STRING
        value: ANY

Full

triggers:
  - keyword: meya.form.component.select
steps:
  - spec: '?'
    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
        icon:
          url: STRING
          color: STRING
          path: STRING
        action: COMPONENT
        result: ANY
        data:
          STRING: ANY
        magic: false
        type: text|url|static|action|flow_next|component_next
        text: STRING
    composer:
      focus: file|image|text|blur
      placeholder: STRING
      visibility: collapse|hide|show
    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