Skip to content

Commit 30dbf7d

Browse files
Add information about design property category
1 parent edbba60 commit 30dbf7d

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Here is a simplified example of a design properties file:
6161
"name": "My Toggle Property",
6262
"type": "Toggle",
6363
"description": "Description of My Toggle Design Property",
64+
"category": "Best place for this toggle property"
6465
"class": "hereMyClass"
6566
},
6667
{
@@ -111,14 +112,26 @@ Every design property in the array is also represented by a *JSON* object. The e
111112

112113
#### Common Fields
113114

114-
The examples above show that the fields `name` and `description` define the UI, the name of a form control in Studio Pro, and the description under it. They are required string values naming and describing a design property.
115+
The common fields, as seen within the example above, are available on all the design properties as defined in the following table.
115116

116-
Field `type` defines the type of a property and must be one of the design property types: `Toggle`, `Dropdown`, `Colorpicker`, `ToggleButtonGroup` or `Spacing`.
117+
118+
| Field | Required | Type | Description |
119+
| -------------- | -------- | ------ | --------------------------------------------------------------------------------------------- |
120+
| `name` | Yes | String | The name and identifier for the design property, that will be displayed on the UI. |
121+
| `description` | Yes | String | A short description of the design property and what it provides. |
122+
| `type` | Yes | String | Defines the type of a property . |
123+
| `category` | No | String | An identifier that will be used to group design properties on the UI (defaults to "General"). |
117124

118125
{{% alert color="warning" %}}
119126
Name your design property and its options carefully. Those names cannot be changed easily when there are apps already using them. If you want to rename a design property which is already being used in an app, see the [Renaming Design Properties](#old-names) section below.
120127
{{% /alert %}}
121128

129+
##### Limitations
130+
131+
It is important to note that the `category` shouldn't be "Common" as this is a reserved category and will cause Studio Pro to raise a warning and display that design property within the default category.
132+
133+
The `type`property must be one of the following design property types: `Toggle`, `Dropdown`, `Colorpicker`, `ToggleButtonGroup` or `Spacing`.
134+
122135
#### Toggle-Specific Fields
123136

124137
Design properties of type **Toggle** have the following additional field:

0 commit comments

Comments
 (0)