tile.rating

type: meya.tile.component.rating
class: RatingComponent
path: /meya/tile/component/rating.py
signature: rating

Fields

field

signature

required

type

default

description               

spec

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

header

HeaderElementSpec

buttons:
title:
progress:
milestones:
extra_buttons:

Override the header for this component

markdown

list
bool
NoneType

null

Override the bot Markdown mode for this component

rating

RatingType

The rating card comes with a number of built-in rating types. The most commonly used one is thumbs, which display thumbs up & down icons. You can also define your own set of icons, and their associated results, by setting this to custom.

options

list

null

If you've set the rating type to custom, then you need to specify a list of rating options. Each option takes an icon spec, text and a score.

fill

bool

null

When this is set to true then the Orb Web SDK will fill the icon with a solid color. Note that this is currently only applicable to the Orb Web SDK.

backfill

bool

null

When this is set to true the Orb Web/Mobile SDK will highlight all the icons up to and including the selected icon. Note that for the Orb Web SDK both fill and backfill need to be set to true.

title

str

A text string describing the purpose of the rating.

Examples

Basic

triggers:
  - keyword: meya.tile.component.rating
steps:
  - rating: faces|stars|thumbs|custom
    title: STRING

Full

triggers:
  - keyword: meya.tile.component.rating
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
    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
    rating: faces|stars|thumbs|custom
    options:
      - icon:
          url: STRING
          color: STRING
          path: STRING
        text: STRING
        score: 123
    fill: false
    backfill: false
    title: STRING