Ninjas Practicing Multidimensionality
Miss any of our Open RFC calls?Watch the recordings here! »

@ant-design/icons-angular

10.0.1 • Public • Published

Ant Design Icons for Angular

NPM version NPM downloads

With a better taste.

Installation

ng add @ant-design/icons-angular
 
# or npm install @ant-design/icons-angular 

Usage

You should import IconModule in your application's root module.

import { IconModule } from '@ant-design/icons-angular';
 
@NgModule({
  imports: [
    IconModule
  ]
})
export class AppModule { }

And register the icons that you need to IconService (all or explicitly, we call it static loading):

ATTENTION! We strongly suggest you not to register all icons. That would increase your bundle's size dramatically.

import { Component, OnInit } from '@angular/core';
import { IconDefinition, IconService } from '@ant-design/icons-angular';
import { AccountBookFill } from '@ant-design/icons-angular/icons'
// import * as AllIcons from 'ant-icons-angular/icons';
 
@Component({
  selector   : 'app-root',
  templateUrl: './app.component.html',
  styleUrls  : ['./app.component.css']
})
export class AppComponent implements OnInit {
  constructor(private _iconService: IconService) {
    // Import all. NOT RECOMMENDED. ❌
    // const antDesignIcons = AllIcons as {
      // [key: string]: IconDefinition;
    // };
    // this._iconService.addIcon(...Object.keys(antDesignIcons).map(key => antDesignIcons[key]));
    // Import what you need! ✔️
    this._iconService.addIcon(...[ AccountBookFill ]);
    this._iconService.twoToneColor = { primaryColor: '#1890ff' };
  }
}

When you want to render an icon:

<i antIcon type="ant-cloud" theme="outline"></i>

Checkout the demo for more details.

For icons provided by Ant Design, we provide dynamic loading strategy to reduce bundle's size. Just config your angular.json and you even don't need to register the icons! Checkout our examples dir and angular.json file for more details.

Namespace

Namespace is a new feature first introduced in 2.0.0-beta.2. It allows users to register their own icons with simple API, support both dynamic loading and static loading.

Say you want to add a panda icon in animal namespace. For static loading, you should call addIconLiteral('animal:panda', '<svg>...</svg>'). For dynamic loading, just put panda.svg under assets/animal. And render a panda like: <i antIcon type="animal:panda">.

Please checkout the demo for more details.

Development

This package, unlike @ant-design/icons-react, does not list @ant-design/icons as a dependency. It has its own build up tooling chain which brings benefits like:

  • Tree shake.
  • Providing dynamic and static loading.
  • Reduced bundle size (500KB less if you only use dynamic loading).
  • Better performance because of no svg => abstract node => svg process.

Setup

Install dependencies of @ant-design/icons-angular, and run npm run generate.

Demo

Run ng serve after npm run generate.

Build

Build the library by running the script we provide.

$ ./build.sh

Extension

You can simply extend this package by creating directives or services that extends IconDirective and IconService. And it is worth mentioning that _changeIcon method returns a Promise<svg> using which you could add extra modifications. ng-zorro-antd is a good example of extending this package.

Keywords

none

Install

npm i @ant-design/icons-angular

DownloadsWeekly Downloads

25,891

Version

10.0.1

License

MIT

Unpacked Size

9.53 MB

Total Files

4007

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar