Nectar of the Programming Masses

    @pxblue/icons-svg

    1.4.0 • Public • Published

    PX Blue SVG Icons

    This is a library of SVG Icons for use in PX Blue applications.

    Installation

    To install the PX Blue 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 @pxblue/icons-svg
    or
    yarn add @pxblue/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 PX Blue 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("@pxblue/icons-svg/breaker.svg").default; // individual icon
    const iconSet = require("@pxblue/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('px-icons', this.domSanitizer.bypassSecurityTrustResourceUrl(iconSet));
      }
    }
    
    // app.component.ts
    <mat-icon svgIcon="px-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="px-icons:bearing" style="color: red"></mat-icon>
    

    React

    import icon from '@pxblue/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 @pxblue/icons-mui or our icon font.

    NOTE: If you will be using many of these icons in your application, we recommend you use @pxblue/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 PX Blue SVG icons by importing and using them as normal components:

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

    Available SVG Icons

    See the Iconography on pxblue.github.io for a list of currently available icons.

    Install

    npm i @pxblue/icons-svg

    DownloadsWeekly Downloads

    202

    Version

    1.4.0

    License

    BSD-3-Clause

    Unpacked Size

    275 kB

    Total Files

    192

    Last publish

    Collaborators

    • avatar