logo
Help Center/Design systems/Libraries/Add descriptions to libraries

Add descriptions to libraries

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

  1. 1.Both designers and developers can access and view the description information.
  2. 2.When searching for component styles in Motiff, the description information will also be searched, so please add descriptions carefully.

Add descriptions

Add descriptions to components

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 descriptions to components.png'

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.Click on a blank area of the canvas.
  2. 2.In the Design panel, view the styles in the file.
  3. 3.Hover over the style and click '16_Panel_Adjust.svg' .

'add style descriptions.png'

  1. 4.

    Add a description for the style in the Edit style panel.

  2. 5.

    Click outside the panel area or click '16_Common_Close.svg' to save the description.

Tips: You can find and open the style definition from any layer that uses that style:

  1. 1.Select a layer that supports that style.
  2. 2.Click on the style in the right sidebar.
  3. 3.Hover over the style and click '16_Panel_Adjust.svg' .
  4. 4.In the View style panel, click Go to style definition to edit.

'Go to style definition to edit.png'

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.

'add library descriptions.png'

Assets panel

You can view component names and descriptions in the Assets panel. Motiff will show component descriptions when you search for a component.

Hover over the component in the Assets panel to view the detailed description of the component. You can see both the component names and descriptions.

You need to have Can edit permissions for the file to open the Assets panel. You will only need Can view permission to the library to use components from that library.

'assets panel.png'

Style picker

View the style name and description from the style picker.

  1. 1.Click '16_Panel_Style.svg' to open the style picker.
  2. 2.Hovering over a style will show the description of that style.

'style picker.png'