Skip to content

Understanding Metadata syntax

Pratik Shah edited this page May 6, 2020 · 1 revision

Sample Metadata:

Define Parent section

#Sample code for a Parent section

!StickerSection @Section
title: Parent Section
description: 'Note that this description supports basic HTML tags:<br/><b>This is Bold</b>'
links:
- title: Dummy Link
  url: http://pratikshah.website

Define Sub section (for a parent named "Section")

#Sample code for a Sub section

!StickerSection @Section.SubSection
title: Sub Section
description: 'Provides description for the Sub-section'
backgroundEach: '#fafafa'
layout: 'row'

Custom Library Name and description

#Sample code for custom Lbrary Name and description

!StickerLibrary
title: My Frist Library
description: 'Library description'

Custom Library icon

To add a custom library icon, append @@icon to the name of any square layer / artboard in your file. For example, to make My custom icon artboard as Library icon it should be renamed to My custom icon @@icon.

Allowed metada properties and values

Below are the currently supported section properties (keys):

Property Type Description
title string optional The title of the section.
If not provided uses sectionId as a title.
sectionId string required Section IDs look like @Section1 or @Section1.SubSection. Note that section IDs can only have letters and numbers, so avoid any special characters like semicolons, spaces, ampersands, etc.
description string optional A longer description of the section and/or sub-section.
background string optional Allows you to add background color to entire sub-section. Takes hex code color values like #ffffff.
backgroundEach string optional Like background, but sets a background color to each Symbol / Sticker.
hideNames boolean optional Default false. If true, hides symbol/sticker names and will show only image preview.
links array optional An array of links to show below the section description, where each link is an object with a title and url.

Only works for Parent sections (e.g. @Section).
layout string optional An optional layout type for sub-sections.
Allowed values are flow and row.

Default layout value for sub-section is flow which arranges symbols in a column/vertically stacked fashion.