@timeling/icons
v1.0.14
Published
Timeling icons.
Downloads
4
Readme
Timeling icons.
Install
npm i @timeling/icons
Relevant scripts
# install libraries
npm install
# compile the library into the "dist" folder
npm run build
# publish the library to npmjs.com
npm publish
How to add new icons to the library
Step 1 Go to the Design System Icons page and select the desired icon: https://www.figma.com/file/kP4r4pHnIx4X9yOtpPxBw6/Design-System?node-id=1137%3A5218
Step 2 Copy it as SVG:
Step 3
Paste your icon into raw/icon-name-variant.svg
(For example, raw/martini-glass-light.svg
) and execute:
npm run build
The previous command will save your icon into the optimized
folder as optimized/icon-name-variant.svg
Step 4 Increase the package version. For example:
// package.json
{
"name": "@timeling/icons",
"license": "UNLICENSED",
- "version": "1.0.12",
+ "version": "1.0.13",
and run
npm publish
Step 5 Don't forget to upload your changes:
git commit -am "add icon-name-variant icon"
git push
Convention
There may be different versions of the same icon. In those cases, simply add a comprehensible suffix. For example:
heart-duotone.svg
heart-light.svg
heart-regular.svg
heart-solid.svg
heart-thin.svg
The previous files generates the following React classes:
HeartDuotoneIcon
HeartLightIcon
HeartRegularIcon
HeartSolidIcon
HeartThinIcon