@brightlayer-ui/icons-mui

Brightlayer UI icons for Material UI

Usage no npm install needed!

<script type="module">
  import brightlayerUiIconsMui from 'https://cdn.skypack.dev/@brightlayer-ui/icons-mui';
</script>

README

Brightlayer UI Supplemental Icons

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

Installation

To install the Brightlayer UI icon font from NPM as a dependency for your project, you can run one of the following commands in your project root:

npm install --save @brightlayer-ui/icons
or
yarn add @brightlayer-ui/icons

You then need to reference the font in your application so that it is available for use.

Angular

In order to use the icon font, you will need to modify your angular.json file "styles" entries (there is one under "build" and one under "test") to include the icon font reference:

"styles": [
    "src/styles.scss",
    "./node_modules/@brightlayer-ui/icons/iconfont/BrightlayerUIIcons.css"
],

React

For React, you'll need to require the font in your top-level JS file (typically index.js).

require('@brightlayer-ui/icons/iconfont/BrightlayerUIIcons.css');

Using the icon font in your application

This will make the Brightlayer UI icons available to your code by using the appropriate class name (className for React) on a <i> element, e.g.:

<i class="blui-ICONNAME"></i>

Applying Different Colors

To change the color of the icon you are using, simply set the CSS color property. This property is inheritable, so if the property is not set on your icon, it will be inherited from the parent container.

<i class="blui-ICONNAME" style="color: red"></i>

Available Icons

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

Usage Alternatives

The icon font is a great way to include lots of icons in your application. If you only need a few, you can also check out these alternative packages:

We also have Brightlayer UI one-line symbols (ported from Brightlayer UI 1.0) available:

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

For Icon Creators

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