Skip to main content

Option

Description​

The User.TappedContinue type defines an action that requires a client to The Option type defines a presentational component intended to behave like an HTML checkbox or radio button. This type can only appear as part of an OptionGroup.

Properties​

  • label (string, required) - The text to be displayed on the control.
  • value (string, required) - The value associated with the control.
  • exclusive (boolean, required) - Whether this control behaves like an HTML checkbox (if false) or radio button (if true).
  • preSelected (boolean) - Whether or not this control is checked by default.

Example​

In the first example the exclusive property is set to false which indicates that this option can be selected alongside others in the associated OptionGroup.

{
  "exclusive" : false,
  "label" : "An option that behaves like a checkbox",
  "value" : "checkbox"
}

In the second example the exclusive property is set to true which indicates that if this option is selected then no other options in the associated OptionGroup may be selected.

{
  "exclusive" : true,
  "label" : "An option that behaves like a radio button",
  "value" : "radio"
}