text.input.base

This is the base text input component that is used by all other text
input field components, and defines some common fields that are used by
all text input components.

This is base component and should not be used directly in your BFML.

Check the Widgets & Pages guide for more info on creating advanced
form wizards for collecting user input using field components.

Element details

type: meya.text.component.input.base
class: BaseTextInputComponent
path: /meya/text/component/input/base.py
signature: -

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
composerThe composer spec that allows you to control the Orb's input composer. Check the Composer guide for more info.â—‹â—‹focus: 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
requiredâ—‹â—‹falsebool
labelâ—‹â—‹nullstr
disabledâ—‹â—‹falsebool
iconThe icon spec or URL to use for the input field. See the Icons guide for more info.â—‹â—‹nullIconElementSpec
str
NoneType
placeholderThe input field's placeholder text. This is displayed when thefield has not user specified text.â—‹â—‹nullstr
defaultThe input's default value.â—‹â—‹nullstr

Usage reference

Basic

triggers: - keyword: meya.text.component.input.base steps: - type: meya.text.component.input.base

Full

triggers: - keyword: meya.text.component.input.base steps: - type: meya.text.component.input.base 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 required: false label: STRING disabled: false icon: url: STRING color: STRING path: STRING placeholder: STRING default: STRING