JSPM

category: packages

ui-icons

Installation

yarn add --dev @instructure/ui-icons

Usage

To use the React components:

import { IconAddLine } from '@instructure/ui-icons'

function MyComponent () {
  return <IconAddLine />
}

Exporting Icons from Sketch files

Run yarn export:icons from the repository root directory to generate the SVG files.

Guidelines for Drawing Icons

• Use dashes in the name of the .sketch files (e.g calendar-month). Use the same name for art-boards, but prefix with the variant, e.g. solid/calendar-month and line/calendar-month.

• Draw your icons on the 1920 x 1920 art-boards that are set up for you in the Sketch template.

• Before you flatten shapes or vectorize strokes as described below, make a hidden copy of the original paths off to the side so that you can more easily come back and make changes later.

• Flatten your shapes (Layer > Paths > Flatten).

• Export strokes to vector (Layer > Convert to Outlines).

• Don’t use borders on vectors, especially not inside/outside borders which aren’t supported in SVG.

• Make sure none of the paths go outside of the art-board. If so, the glyph in the icon font will be misaligned. Draw inside the lines.

• Fill the space edge-to-edge as much as possible. The build process will add margins as needed.