Learn how to manage custom properties in your design system.
Create a new custom property
- In the Tokens table or Components table, click the + button.
- Click New custom property from the dropdown menu.
- In the dialog, enter a name and select which type of property you want to add.
- Open the More options section of the dialog to add a description or edit the identifier for code (if you don't edit this, it will be automatically created based on what you named the property).
- Further fields may appear in the dialog depending on which custom property type you choose.
- Click Create property.
- A new custom property column will be created and the values can be filled in for each token.
Custom property requirements
Type |
The type of property. |
---|---|
Name |
Name of the property. |
Code name |
The code-friendly version of the property name, and the name to be used in code generation. This is generated from the custom property name, but you can change it. |
Description (optional) |
Description of how the property should be used. |
Edit a custom property
- In the property column header, click ... to open the context menu.
- Select Edit from the menu.
- Make any necessary edits and click Save.
Edit and remove select property options
A select property type requires one or more options. When creating the property, you will have the opportunity to add options in the dialog. Select options can be edited or removed at any time.
In the Edit property dialog, you can:
Move option
- Select the drag icon to the left of the option row.
- Click and hold. Drag the option to move it.
Edit option color
- Cick the color preview to select a new color.
- Click the Reset icon to reset the color to default.
Remove options
If an option is removed it will be removed from all components that contain that value.
- Click the x icon to remove the option.
Delete a custom property
- In the property column header, click ... to open the context menu.
- Select Delete property from the menu.
- In the dialog, enter the text DELETE to confirm.
- All custom property values and any references in documentation will be removed.