npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@brightlayer-ui/icons-svg

v1.15.0

Published

SVG icons for Eaton applications

Downloads

8,699

Readme

Brightlayer UI SVG Icons

Build

This is a library of SVG Icons for use in Brightlayer UI applications.

Installation

To install the Brightlayer UI SVG Icons 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-svg
or
yarn add @brightlayer-ui/icons-svg

Angular

The method described below for Angular requires you to install the Angular CDK and Angular Material:

cd projectname
yarn add @angular/cdk @angular/material

and also include the following modules:

// app.module.ts
import {MatIconModule} from '@angular/material/icon';
import {HttpClientModule} from '@angular/common/http';
...
imports:[
  MatIconModule,
  HttpClientModule
]

Usage

Angular

The simplest way to use these SVGs in Angular is to register them with the matIconRegistry so they can be used with the <mat-icon> tag. You can register icons individually, or as the entire Brightlayer UI set:

import { Component } from "@angular/core";
import { MatIconRegistry } from "@angular/material/icon";
import { DomSanitizer } from "@angular/platform-browser";

declare var require: any;
const icon = require("@brightlayer-ui/icons-svg/breaker.svg").default; // individual icon
const iconSet = require("@brightlayer-ui/icons-svg/icons.svg").default; // full set

Then, in your constructor, register the icon or the icon set. It will then be available for use as a <mat-icon>.

Individual Icon

// app.component.ts
export class AppComponent {
  constructor(
    private matIconRegistry: MatIconRegistry,
    private domSanitizer: DomSanitizer
  ) {
    this.matIconRegistry.addSvgIcon(
      "breaker",
      this.domSanitizer.bypassSecurityTrustResourceUrl(icon)
    );
  }
}
// app.component.html
<mat-icon svgIcon="breaker"></mat-icon>

Entire Icon Set

// app.component.ts
export class AppComponent {
  constructor(
    private matIconRegistry: MatIconRegistry,
    private domSanitizer: DomSanitizer
  ) {
    this.matIconRegistry.addSvgIconSetInNamespace('blui-icons', this.domSanitizer.bypassSecurityTrustResourceUrl(iconSet));
  }
}
// app.component.ts
<mat-icon svgIcon="blui-icons:bearing"></mat-icon>

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.

<mat-icon svgIcon="blui-icons:bearing" style="color: red"></mat-icon>

React

import icon from '@brightlayer-ui/icons-svg/ICON_NAME.svg';
...
<img src={icon}/>

NOTE: SVG icons used in this manner will appear black. The fill color cannot be changed because the SVGs are not inline. If you want to color the icons, you will want to use the @brightlayer-ui/icons-mui or our icon font.

NOTE: If you will be using many of these icons in your application, we recommend you use @brightlayer-ui/icons-mui or our icon font to simplify usage. This library makes more sense if you just need one or two icons or if you want to reduce the size of your bundle.

React-Native

React Native does not have built in support for SVG images. However, there are libraries available that will make them usable in your application. We recommend using react-native-svg-transformer in conjuction with react-native-svg. These will allow you to include Brightlayer UI SVG icons by importing and using them as normal components:

import Leaf from "@brightlayer-ui/icons-svg/leaf.svg";
...
<Leaf width={50} height={50} fill={'green'} />

Available SVG Icons

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