Grouping Controls

Groups allow you to organise similar settings into relevant sections in the inspector.

circle-info

The icon property uses SF Symbols. Please refer to the SF Symbol apparrow-up-right for a list of available icons.

Here is an example empty group:

{
  "groups": [
    {
      "title": "Color Settings",
      "icon": "paintpalette",
      "properties": []
    }
  ]
}

Group Icon

You can specify an icon to appear next to the title of your group. The Icon property uses SF Symbols. Please refer to the SF Symbol apparrow-up-right for a list of available icons.

Group Controls

Controls should be placed inside the properties array. The following example has a heading, a text field, and an image dropwell inside the group.

{
  "groups": [
    {
      "title": "Hero Content",
      "icon": "textformat.size",
      "properties": [
        {
          "title": "Headline",
          "id": "heroHeadline",
          "text": {
            "default": "Launch your next product"
          }
        },
        {
          "title": "Subheading",
          "id": "heroSubheading",
          "textArea": {
            "default": "A short sentence explaining the value proposition."
          }
        },
        {
          "title": "Background Image",
          "id": "heroImage",
          "image": {}
        }
      ]
    }
  ]
}

The following example has two groups, one for content and one for media.

Last updated

Was this helpful?