@nulogy/icons
v4.37.2
Published
A collection of Nulogy's svg icons
Downloads
1,462
Keywords
Readme
@nulogy/icons
A collection of Icons that are used by Nulogy applications.
📦 Installation
The icons are required as a peer dependency of @nulogy/components
. You can install them using:
$ yarn add @nulogy/icons
It is recommended to use the icons is through the icon
prop in the <Icon />
component from @nulogy/components
.
➕ Adding a new icon
To find and add a new icon:
- 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
- Add the icon to the NDS design system
Icons
page in Figma - Clone this repo (
git clone [email protected]:nulogy/nds-icons.git
) - 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 - Commit the changes using a conventional commits message
- Submit PR