react-icons

NPM package containing icons as React components used by Urban Sharing.

Getting started

First, install the package by running yarn add @urbaninfrastructure/react-icons. Then, import the icons you want to use in your files:

import { Check as CheckIcon } from '@urbaninfrastructure/react-icons'

const App = () => <CheckIcon />

Adding new icons

To add new icons, put the svg icon in /icons, then run yarn prepare. Remember to preview your icon in the docs, run yarn storybook in root, and visit Icon/All.

We use Jest snapshot testing for the icons, so you need to update the snapshots by running yarn test -u after adding new icons.

If it looks ok, create a new version by running yarn release from root.