Show a checkbox for the user to check.

Here is a basic example:

- checkbox: Accept terms & conditions
  required: true

Which produces the following in the Meya Orb Web SDK client:

The ask tiles component is also an interactive component which allows you to set
quick replies, configure the input composer
and set context data.

Here is a more advanced example:

- checkbox: Accept terms & conditions
  required: true
  quick_replies:
    - text: Discover earth
      action:
        flow: flow.earth
    - text: Talk to an agent
      action:
        flow: flow.agent
  context:
    foo: bar
  composer:
    focus: blur
    visibility: collapse
    collapse_placeholder: Ask a question

Which produces the following output:

Note, this component is only compatible with the Meya Orb Web/Mobile SDK.
Check the compatibility matrix
and integration documentation to see which features the specific integration
you are using supports.

Input validation

If the required field is set to true then the input component will
display an error if the user submits no value.

Here is an example of the error:

The user's input text is always stored in (@ flow.result ) in your app's
flow scope data.

Pages support

This checkbox component is also a widget component that can be displayed as a field
in a page.

Here is an example using the text input component in a page:

- page:
  - checkbox: Accept terms & conditions
    required: true

Which produces the following output:

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

Element details

type: meya.tile.component.checkbox
class: CheckboxInputComponent
path: /meya/tile/component/checkbox.py
signature: checkbox

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
checkbox	Text for the checkbox field.	◉	◉		str
default	Specify a default value if this field is not required, and the user does not submit a value.	○	○	null	bool
submit	The text of the submit button which defaults to `Submit` if not specified. Check the `CheckboxInputSubmitButtonElementSpec` Python class to see what each field does.	○	○	text: Submit	CheckboxInputSubmitButtonElementSpec
error_message		○	○	"Please check this box"	str

Usage reference

Basic

triggers:
  - keyword: meya.tile.component.checkbox
steps:
  - checkbox: STRING

Full

triggers:
  - keyword: meya.tile.component.checkbox
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
    checkbox: STRING
    default: false
    submit:
      text: STRING
    error_message: STRING