checkboxConfig

Examples

kind: Checkbox
label: My Label
choices: 
  - label: Option 1
    value: 1
  - label: Option 2
    value: 2
disableWhen: # OPTIONAL
  kind: Equal
  control: my-other-control1
  value: 1
hideWhen: # OPTIONAL
  kind: Falsy
  control: my-other-control2

Object properties

Name	Type	Required
kind	Constant: `Checkbox`	yes
label	string	yes
choices	Array	yes
disableWhen	One of	no
hideWhen	One of	no

Object information

Object with the following properties:
- kind (required): Constant Checkbox
  - Checkbox is used to display a list of choices for the user to select from
- label (required): string
  - The label of the checkbox
- choices (required):
  - The choices for the user to select from
  - Array of:
    - Object with the following properties:
      - label (required): string
        
        The label to be displayed in the dropdown
      - value (required): string
        
        The value to be used for selected choice
- disableWhen (optional):
  - Disable this control based on another control’s value
  - One of the following types:
    - Object falsyConfig
    - Object truthyConfig
    - Object equalConfig
    - Object notEqualConfig
- hideWhen (optional):
  - Hide this control based on another control’s value
  - One of the following types:
    - Object falsyConfig
    - Object truthyConfig
    - Object equalConfig
    - Object notEqualConfig