orb.hero

type: meya.orb.component.hero
class: HeroComponent
path: /meya/orb/component/hero.py
signature: hero

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

Override the Orb composer for this component

markdown

list
bool
NoneType

null

Override the bot Markdown mode for this component

hero

str

description

str

null

Examples

Basic

triggers:
  - keyword: meya.orb.component.hero
steps:
  - hero: STRING

Full

triggers:
  - keyword: meya.orb.component.hero
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
    hero: STRING
    description: STRING