Document optgroups for selects

2026-08-30 22:06:45 -04:00 · 2016-05-28 14:50:06 -07:00
parent 41d38e04a7
commit 782eaf82f3
1 changed files with 54 additions and 0 deletions
@@ -291,6 +291,60 @@ A dropdown menu containing multiple options.
 }
 ```

+If you wish to use optgroups, then use the following format:
+
+```javascript
+{
+  "type": "select",
+  "appKey": "flavor",
+  "defaultValue": "grape",
+  "label": "Favorite Flavor",
+  "options": [
+    { 
+      "label": "", 
+      "value": "" 
+    },
+    {
+      "label": "Fruits",
+      "value": [
+        { 
+          "label": "Berry",
+          "value": "berry" 
+        },
+        { 
+          "label": "Grape",
+          "value": "grape" 
+        },
+        { 
+          "label": "Banana",
+          "value": "banana" 
+        }
+      ]
+    }, 
+    {
+      "label": "Candy",
+      "value": [
+        { 
+          "label": "Chocolate",
+          "value": "chocolate" 
+        },
+        { 
+          "label": "Cream",
+          "value": "cream" 
+        },
+        { 
+          "label": "Lollipop",
+          "value": "lollipop" 
+        }
+      ]
+    }
+  ],
+  "attributes": {
+    "required": "required"
+  }
+}
+```
+
 ---

 #### Color Picker