The Checkbox widget allows you to provide a list of options for a user and receive one or more selections as an input value. Multiple options can be chosen by the user. If you need to have a single selection by the user, check out the Radio component.
|name||Y||The name attribute needs to be unique for each component. When a submit comes from the UI, an action is made available in Form and Flow XSL files via outgoing context. |
|type||Y||“checkbox” is the only valid value.|
|title||N||Label for the widget. Setting the value to “hidden” has the same result as leaving it empty. This text appears above the options.|
|group||N||Assigns a logical grouping to a single multiple components that allow them to be resized using reactive breakpoints. This is required for colSize to work.|
Comma separated string of reactive breakpoints and the number of grid spaces acquired by the widget.
|enum||Y||Comma-separated values that represent the value associated with the option the user picks. The order of |
|enumTitles||Y||Comma-separated strings that represent the label for each of the |
|enumIcons||N||Comma-separated strings that provide the icon name to use for the specific value. These correspond to the same index as |
|icon||N||String name of an icon from the Ionic Icons v3 collection. e.g. “md-add”. Aligns to the left side of the button |
|required||false||N||Boolean. Indicates whether or not the component must have user input before the form can be submitted. When set to “true” the component will often appear with a trailing “*”.|
|disabled||false||N||Cause it to become unresponsive to user input – “greyed out”. This can be used to control when the user is able to trigger the associated action.|
<property name="required_services" title="How can we help you?" type="checkbox" enumIcons="car, refresh, funnel, hammer" enum="oc, tr, ftc, br" enumTitles="Oil Change, Tire Rotation, Filter Change, Body Repair" />