README.md

Brightlayer UI Icons

This is a library of supplemental icons, to be used in conjunction with the standard Material Design icons in Brightlayer UI applications.

These icons are available in various formats to suit your needs:

• Icon Font (npm, src)
• SVG Icons (npm, src)
• React Components (npm, src)
• React Native Vector Icons (npm,src)
• PNG Files (src)

Our library of dynamic progress icons has been split off into a dedicated repository:

• Progress Icons

Available Icons

See the Iconography on brightlayer-ui.github.io for a list of currently available icons.

For Icon Creators

Please read the instructions in the Design folder before creating or submitting new icons.

For Maintainers / Contributors

This repository uses yarn workspaces with the latest version of yarn. To get started working with the libraries:

git clone https://github.com/etn-ccis/blui-icons.git
cd blui-icons
yarn install

After you have made changes, you may build the packages:

yarn build

There is a demo project in the repository which shows the various icon formats being used in a project. To start the demo, ensure that the demo project is using the latest version of packages you created before spinning up the development server:

yarn update:demo
yarn start