@giosg-design-system/icons
v1.1.0
Published
svg based react icon components
Downloads
109
Readme
Contribution guide.
We welcome contributions from everyone. Here are a few ways you can help.
Intro
Before you start the best thing you could do is to read the icon's package overview in Storybook to familiarize yourself with the package and the main key points.
➕ How to add a new icon
- Create a new branch
- Ask your designer to provide you a new icon or pick an already added one from the design system figma.
- The icon should follow some rules designers have documented. For example, it should have
main
,alt
oraccent
data-id attributes on corresponding parts of an svg and theheight
should be 24px andviewport
property is present. In practice, you should go to./src/svg/
to compare with the existing set. - Put the provided svg into
./src/svg/
. - Run
pnpm svg
- that will trigger the pipeline to produce a component. - Update tests/screenshots if needed.
- Commit your changes if you are fine with them.
- Read the general rules on how to create changesets in publishing settings