Skip to content

Latest commit

 

History

History
28 lines (17 loc) · 1.47 KB

README.md

File metadata and controls

28 lines (17 loc) · 1.47 KB
Raw

@nulogy/icons

This is a collection of Material Icons that are used by Nulogy applications. This package is already imported into the <Icon /> component of the @nulogy/components, and the icons here can be chosen with the icon prop.

npm (scoped)

📦 Installation

If you don't have access to the React component, you can install these directly:

$ yarn add @nulogy/icons

They can then be used in your application like any other .svg.

➕ Adding a new icon

To find and add a new icon:

  1. Search Material Icons for the icon you need and download it. Alternatively, in Figma, use the Material Design Icons plugin to add the icon to a page then export the icon as SVG
  2. Add the icon to the NDS design system Icons page in Figma
  3. Clone this repo (git clone git@github.com:nulogy/nds-icons.git)
  4. Place SVG in assets/ folder with the desired icon name (in camelCase). The name of the icon should match the icon's name in Figma. Consult with the designer what the desired name should be, otherwise use the name provided in Material Icons
  5. Commit the changes using a conventional commits message
  6. Submit PR

💬 Questions

  • #design-system