@sproutsocial/seeds-icons

Seeds Icons

This package contains all the assets for icons used by Sprout Social. This package is automatically updated with Figma.

Installation

Run the following command to install @sproutsocial/seeds-icons:

yarn add @sproutsocial/seeds-icons

Usage

It is recommended to use this package in conjunction with @sproutsocial/racine and the Icon component. Check your version of Racine's peer dependencies to know exactly which versions of this package are compatible.

In order for the SVG assets to be utilized in your application, they need to be loaded onto the page. this can be done utilizing the sprite sheets found in dist/sprites/ or by importing the sprite sheets as strings using the <Category>Sprite import.

For additional guidance on loading SVGs in an application, please visit the documentation on the reference site.

For more details on using the Icon component check out the documentation on the reference site.

Icon Categories

Icons are broken up into the following categories:

• General - for icons that are non-Sprout/application specific
• Sprout - for icons that are specific to Sprout
• External - for icons owned by external companies

For a list of all available icons, please visit the icon search page on the reference site.

Adding a new icon or modifying an existing one

To add a new icon to this package, the icon should be added to Sprout Social's Figma page for icons. This page is used as a source of truth for assets in this package. Similarly, to modify an icon in this package, modify the corresponding icon on the Figma page.

A GitHub Action triggers twice a day to retrieve the assets from Figma and create a PR containing any changes. After the PR is approved and merged, a release is created for this package with the latest changes.