selectionControlConfig

Examples

kind: Select
choices: 
  - kind: Color
    label: Red
    value: red
    color: [222, 0, 0]
  - kind: Color
    label: Blue
    value: blue
    color: [0, 0, 255]
label: My Label
value: red # OPTIONAL
columns: 2 # OPTIONAL
height: 30px # OPTIONAL
itemHeight: 60px # OPTIONAL
disableWhen: # OPTIONAL
  kind: Equal
  control: my-other-control1
  value: 1
hideWhen: # OPTIONAL
  kind: Falsy
  control: my-other-control2
updateChoicesWhen: # OPTIONAL
  kind: Match
  control: my-other-control3
  matchValues:
    - value: true
      choices:
        - kind: Color
          label: Red
          value: red
          color: [222, 0, 0]
        - kind: Color
          label: Green
          value: green
          color: [0, 255, 0]

Object properties

Name	Type	Required
kind	Constant: `Select`	yes
choices	One of	yes
label	string	yes
value	string	no
columns	number	no
height	number	no
itemHeight	number	no
disableWhen	One of	no
hideWhen	One of	no
updateChoicesWhen	Object: updateChoicesWhen	no

Object information

Object with the following properties:
- kind (required): Constant Select
  - Select is used to select an item from a list of items
- choices (required):
  - A list of choices to select
  - One of the following types:
    - Array of:
      - Object colorChoiceConfig
    - Array of:
      - Object imageChoiceConfig
- label (required): string
  - Text displayed above the control
- value (optional): string
  - Optionally define the start value of the control
- columns (optional): number
  - Optionally set the number of equal sized columns in which the selection items are displayed, default is 3
- height (optional): number
  - Optionally define the height of the selection grid, default is 300
- itemHeight (optional): number
  - Optionally set the heigh of each item in the grid, default is 50
- 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
- updateChoicesWhen (optional): Object updateChoicesWhen