@ant-design/icons-angular
TypeScript icon, indicating that this package has built-in type declarations

17.0.0 • Public • Published

Ant Design Icons for Angular

NPM version NPM downloads

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:

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

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: <span antIcon type="animal:panda">.

Please checkout the demo for more details.

Development

You can find the source code here.

Setup

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

Demo

Run npm run generate and then npm run start.

Build

Run npm run build:lib.

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.

Readme

Keywords

none

Package Sidebar

Install

npm i @ant-design/icons-angular

Weekly Downloads

70,848

Version

17.0.0

License

MIT

Unpacked Size

5.06 MB

Total Files

3189

Last publish

Collaborators

  • madccc
  • afc163
  • vthinkxie
  • zombiej
  • chenshuai2144
  • vagusx
  • arvinxx
  • simplejason