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
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 | The 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 |
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 |
required | â—‹ | â—‹ | false | bool | |
label | â—‹ | â—‹ | null | str | |
disabled | â—‹ | â—‹ | false | bool | |
icon | The icon spec or URL to use for the input field. See the Icons guide for more info. | â—‹ | â—‹ | null | IconElementSpec str NoneType |
placeholder | The input field's placeholder text. This is displayed when thefield has not user specified text. | â—‹ | â—‹ | null | str |
default | The input's default value. | â—‹ | â—‹ | null | str |
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
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
requiredfalse
label STRING
disabledfalse
icon
url STRING
color STRING
path STRING
placeholder STRING
default STRING