ToggleGroup

Defines a ToggleGroup which may appear in control extension points such as the property panel

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
[
  {
    "type": "togglegroup",
    "macroParameter": "toggleGroupMacroParameter",
    "controls": [
      {
        "type": "togglebutton",
        "macroParameterValue": "macroParameterValue 0",
        "label": {
          "value": "My Custom Control 0"
        },
        "key": "my-custom-toggle-button-0"
      },
      {
        "type": "togglebutton",
        "macroParameterValue": "macroParameterValue 1",
        "label": {
          "value": "My Custom Control 1"
        },
        "key": "my-custom-toggle-button-1"
      }
    ]
  }
]

Properties

controls
Type
Required
Yes
Description

Toggle buttons which will appear in the toggle group


macroParameter
Type
Max length
100
Required
Yes
Pattern
[-_a-z0-9\.]+
Description

The macro parameter identifier used to store the toggle state. It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.


type
Type
Required
Yes
Allowed values
  • togglegroup
  • TOGGLEGROUP
Description

The type field must be set to 'togglegroup'


Rate this page: