ngx-phosphor-icons v1.0.5

ngx-phosphor-icons

Phosphor is a flexible icon family for interfaces, diagrams, presentations, buttons — whatever, really. Explore all our icons at phosphoricons.com.

ngx-phosphor-icons It is designed to be used together with @angular/Material since it seeks to integrate the Phosphor icons into @angular/material/icon, allowing it to be used in an easy and orderly way.

Installation

npm install --save ngx-phosphor-icons

Imports

There are two ways of implementation, choose the one you like best.

Module Import (Option 1)

Simply import the NgxPhosphorIconsModule into the AppModule so that the entire project can use the icons, or into the module you require. (This module has all types of icons).

import { AppComponent } from 'app/app.component';
...
import { NgxPhosphorIconsModule } from 'ngx-phosphor-icons';

@NgModule({
    declarations: [
      AppComponent,
    ],
    imports: [
      NgxPhosphorIconsModule, // Phosphor Icon Pack
      MatIconModule, // It is important to import the Icon material module.
    ]
  })
export class AppModule {}

Other Modules (Optional).

You can choose the type of icon of your choice, if you only want to load the package.

Module File Import (Option 2)

This form of import has the same characteristics, only that the file is consulted when starting the angular.json. The Modules Change Name and include the "File" Label

In the "input" path: You can specify only one import file if you want or leave it like this to import everything

"assets": [
      "src/assets", 
      ...,
      {
          "glob": "**/*",
          "input": "node_modules/ngx-phosphor-icons/icons/", // Here
          "output": "./assets/icons/"
      }
  ],

Module File List

Props

Icon components accept all props that you can pass to a normal SVG element, including inline style objects, click handlers, and more.

The properties are defined by Angular and @angular/material/icon

Usage

In the phosphoricons.com. documentation the icon calling is done as follows.

<i class="ph-bold ph-graduation-cap"></i>

In this implementation the width type and icon name are called

"ph-bold:graduation-cap"

You can use the icons in different ways, please read the @angular/Material documentation.

Decorative icons

When the icon is purely cosmetic and conveys no real semantic meaning, the <mat-icon> element is marked with aria-hidden="true".

Interactive icons

Icons alone are not interactive elements for screen-reader users; when the user would interact with some icon on the page, a more appropriate element should "own" the interaction:

The <mat-icon> element should be a child of a <button> or <a> element. The parent <button> or <a> should either have a meaningful label provided either through direct text content, aria-label, or aria-labelledby.

Example

  // Icon
  <mat-icon svgIcon="ph-bold:airplane"></mat-icon>
  <mat-icon svgIcon="ph-duotone:airplane"></mat-icon>
  <mat-icon svgIcon="ph-fill:airplane"></mat-icon>
  <mat-icon svgIcon="ph-light:airplane"></mat-icon>
  <mat-icon svgIcon="ph-regular:airplane"></mat-icon>
  <mat-icon svgIcon="ph-thin:airplane"></mat-icon>

  // Button
  <button  mat-icon-button color="warn" type="button">
    <mat-icon svgIcon="ph-bold:trash"></mat-icon>
  </button>
  ...

Donate

If you can help me I will appreciate it very much.

Our Related Projects

• @phosphor-icons/core ▲ Phosphor icon assets and catalog
• @phosphor-icons/react ▲ Phosphor icon component library for React
• @phosphor-icons/web ▲ Phosphor icons for Vanilla JS
• @phosphor-icons/vue ▲ Phosphor icon component library for Vue
• @phosphor-icons/elm ▲ Phosphor icons for Elm
• @phosphor-icons/flutter ▲ Phosphor IconData library for Flutter
• @phosphor-icons/webcomponents ▲ Phosphor icons as Web Components
• @phosphor-icons/figma ▲ Phosphor icons Figma plugin
• @phosphor-icons/sketch ▲ Phosphor icons Sketch plugin

Community Projects

• phosphor-react-native ▲ Phosphor icon component library for React Native
• phosphor-svelte ▲ Phosphor icons for Svelte apps
• phosphor-r ▲ Phosphor icon wrapper for R documents and applications
• blade-phosphor-icons ▲ Phosphor icons in your Laravel Blade views
• wireui/phosphoricons ▲ Phosphor icons for Laravel
• phosphor-css ▲ CSS wrapper for Phosphor SVG icons
• ruby-phosphor-icons ▲ Phosphor icons for Ruby and Rails applications
• eleventy-plugin-phosphoricons ▲ An Eleventy plugin for add shortcode, allows Phosphor icons to be embedded as inline svg into templates

LICENSE

This project is licensed under the MIT License.