@brevio/icons

Brevio icons

This is the @brevio/icons library v3, consisting of the iconography elements used in our frontend components/design.

Usage

Installation

npm install @brevio/icons

Simple example

import { Icons } from "@brevio/icons";

<Icons.Hamburger size="xl" active inverted ref={myRefHook} />;

Concurrent usage with v2

Until the redesign is fully implemented, we will be using both v2 and v3 versions of the @brevio/icons package concurrently. This is achieved using npm package aliasing, for example in package.js:

"dependencies": {
  "@brevio/icons": "^2.0.0",
  "@brevio/icons-v3": "npm:@brevio/icons@^3.0.0"
}

and then

import { Icons } from "@brevio/icons";
import { Icons as IconsV3 } from "@brevio/icons-v3";

Automatic generation

Currently, due to the large amount of icons, src/icons/components is generated using the SVGR tool that turns the raw svg files in svg/icons into React components, using the template svgr/template.js.

All the SVGR processing is configured in package.js, field svgr.

This process can be run with npm run build:icons.

Publishing new version

• Change version number in package.json
• Run npm i to update package-lock.json
• npm run build to build
• git commit -am "<commit message>"
• git tag -a v3.<minor>.<patch> -m "<release message>"
• git push --tags origin
• npm publish --access public