@leafygreen-ui/icon

Icon

Usage

npm install @leafygreen-ui/icon

Example

import Icon from '@leafygreen-ui/icon';

const SomeComponent = () => <Icon glyph="plus" fill="#FF0000" />;

Output HTML

<svg width="16" height="16" role="img" viewBox="0 0 16 16" fill="#000000" size="16">
	<title>Plus Icon</title>
	<path d="M9 7h4v2H9v4H7V9H3V7h4V3h2v4z" fill="#FF0000" fill-rule="evenodd"></path>
</svg>

Properties

glyph

Type: String (Required)

Specifies the glyph to use. This can be one of the following:

Copy, Bell, Building, CaretUp, CaretDown, CaretRight, CaretLeft, Checkmark, CheckmarkWithCircle, ChevronUp, ChevronDown, ChevronRight, ChevronLeft, Charts, Cloud, CreditCard, Edit, Ellipsis, InfoWithCircle, Laptop, Lock, MagnifyingGlass, Menu, NotAllowed, Person, PersonWithLock, Plus, PlusWithCircle, QuestionMarkWithCircle, Refresh, Save, Settings, Stitch, Support, Trash, Warning, X, XWithCircle

size

Type: String or Number

Default: default

The height and width of the glyph's viewBox. This can be any number or one of the following:

default, large, xLarge

fill

Type: String

Default: #000000

The fill color that is passed to the glyph.

Advanced Usage (Registering custom icon sets)

This package exposes a method used to generate a custom version of the Icon component with any specified set of icons.

// Import the createIconComponent method from the Icon package
import { createIconComponent } from '@leafygreen-ui/Icon';

// Create your 'glyphs' object. For each key / value pair, the key will be the name of the icon,
// and the value can be any valid React component.
const myGlyphs = {
  MyCustomGlyph: () => <svg />,
};

// The createIconComponent function returns your custom Icon component.
const MyIconComponent = createIconComponent(myGlyphs);

// Your icon is now ready to use!
const SomeComponent = () => (
  <div>
    <Icon glyph="MyCustomGlyph" />
  </div>
);

We also export the default icon set for you! If you want to include our glyphs with your custom glyphs, you can do something like this:

import { createIconComponent, glyphs } from '@leafygreen-ui/Icon';

const myGlyphs = {
  ...glyphs,
  MyCustomGlyph: () => <svg />,
};

const MyIconComponent = createIconComponent(myGlyphs);