Truehome Icons Library

This project is a collection of react components that will render an icon that will be used across any of the Truehome projects.

Usage

To install the icons on any other project, you can install it running

npm install @truehome/icons

This will install the icons, enabling to use them like any other react component.

import IconName from "@truehome/icons/icon-name"

...

<IconName />
<IconName className={styles.aditionalStylingClass} />
...

Adding new icons

The src folder contains all the icons in a svg format. To convert them to react format, execute:

npm run build

This will create a build directory with the icon components. Each icon component will have the same name as the svg, replacing spaces for dashes (-).

Releasing

To release a new version to the registry, the version inside the package.json should be bumped. After that, run:

npm run release