Add descriptions to libraries

You can add descriptions to components and styles to help users understand the usage guidelines of components and styles.

Add descriptions

Add style descriptions

Add a description to the style definition in the library file. You need to create a style before adding a description to it.

1. 1.Hover over the style in the Design panel and click .

1. 2.Add a description for the style in the Edit style panel.
2. 3.Click outside the panel area or click to save the description.

Add component descriptions

To add descriptions to components, you need Can edit permissions for the file. You can add descriptions to main components, component sets, or variants within component sets:

1. 1.Open the file where the main component is located. If you have selected an instance, you can choose Go to main component to access the file where the main component is located.
2. 2.Select the main components, component sets, or variants within component sets.
3. 3.Add a description for them in the right sidebar.

Add library descriptions

You can also add descriptions when publishing or updating a library.

These descriptions are displayed in the Publish library panel. Any file that references the styles and components in this update will receive a notification. You can view the new descriptions in the updated list for components and styles.

View descriptions

You can view component and style descriptions through the Assets panel or the Style picker, making it easier to understand their purpose and usage.

• Assets panel: Hover over a component to see its name and description.

• Style picker: Click to open the style picker, then hover over a style to view its description.