@salesforce-ux/sds-guideline-iconography
About
The design guidelines for creating iconography at Salesforce.
Looking for all design guidelines? see @salesforce-ux/sds-guidelines.
Installation
Use npm to install the SDS Design Guideline for Iconography:
npm install --save-dev @salesforce-ux/sds-guideline-iconographyUsage
A design guideline is made up of two things:
- A markdown file containing words and images
- A metadata file containing usage guidelines
{
html: '<h2 id="overview">Overview</h2>\n' +
'\n' +
'<p>Five types of icons are used to communicate information within Salesforce, each with variations based on use case and representation. From most to least used, they are:</p>\n' +
...,
meta: [{
name: 'iconography',
category: 'brand',
file: 'iconography.md',
status: 'DRAFTED',
created_at: 'YYYY-MM-DD',
updated_at: 'YYYY-MM-DD',
platforms: ['Web', 'iOS', 'Android', 'Aura'],
systems: ['slds'],
}]
}Other File Formats
Additionally, these other formats are available for use:
markdownhtmlcommonjs
These file formats are located under /dist and do not have metadata.