Collect multiple ratings in a single block. Each group displays a
title and a set of rating icons. The user selects one option per
group and submits all selections at once.
- type: meya.tile.component.multi_rating
label: Please rate your experience
required: true
groups:
- title: Product quality
rating: stars
- title: Support experience
rating: thumbs
The result is a list of scores in group order, e.g. [4, 1].
This component is also a widget component that can be displayed as a
field in a page.
Check the Widgets & Pages
guide for more info on creating advanced form wizards for collecting
user input.
Element details
type: meya.tile.component.multi_rating
class: MultiRatingComponent
path: /meya/tile/component/multi_rating.py
signature: groups
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 | Override the Orb composer for this component. | ○ | ○ | 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 | |
| groups | List of rating groups to display. | ◉ | ◉ | list | |
| submit | Submit button configuration. | ○ | ○ | text: Submit | MultiRatingSubmitButtonElementSpec |
| error_message | ○ | ○ | "Please provide all ratings." | str | |
Usage reference
Basic
triggers:
- keyword: meya.tile.component.multi_rating
steps:
- groups:
- title: STRING
Full
triggers:
- keyword: meya.tile.component.multi_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
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
groups:
- title: STRING
rating: faces|stars|thumbs|custom
options:
- icon:
url: STRING
color: STRING
path: STRING
text: STRING
score: 123
fill: false
backfill: false
submit:
text: STRING
error_message: STRING
