@clds/icon
v0.50.0
Published
## Adding new icon
Downloads
2,507
Readme
@clds/icon
Adding new icon
Icons are managed in a special template in src/template/index-icons.tsx
.
This package autogenerates two files: index.tsx
and metadata.ts
.
index.tsx
is for production apps that don't require icon metadata.
metadata.ts
is for development apps that need to access icon information such as name, keywords, or category.
In order to add your icon successfuly, you need to:
- add your icon in src/template/index-icons.tsx
- run
pnpm nx workspace-generator generateCode
from the package directory - add icon to the stories:
libs/components/icon/stories/Icons.stories.mdx
- commit
- if you forget to generate code from the template, GitHub would do it for you by adding new commit in your PR
Please don't edit main files directly since they will be overwritten next time someone changes something in the template.
Versioning
This library follows Semantic Versioning.
License
See LICENSE