Ant Design Icons for Angular


Installation

``bash
ng add @ant-design/icons-angular

or npm install @ant-design/icons-angular


`

Usage

You should import IconDirective in your component.

`ts
import { IconDirective } from '@ant-design/icons-angular';

@Component({
imports: [ IconDirective ]
})
export class AppComponent {}
`

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.

`ts
import { Component } from '@angular/core';
import { IconService } from '@ant-design/icons-angular';
import { AccountBookFill } from '@ant-design/icons-angular/icons'
// import * as AllIcons from 'ant-icons-angular/icons';

@Component({
// ...
})
export class AppComponent {
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' };
}
}
`

You can also provide icons you need in the app.config.ts:

`ts
import { ApplicationConfig } from '@angular/core';
import { provideAntIcons } from '@ant-design/icons-angular';
import { AccountBookFill } from '@ant-design/icons-angular/icons';

export const appConfig: ApplicationConfig = {
providers: [
provideAntIcons([ AccountBookFill ])
]
};
`

When you want to render an icon:

`html

`

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.

$3

Namespace is 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', ''). For dynamic loading, just put panda.svg under assets/animal. And render a panda like: .

Please checkout the demo for more details.

Development

You can find the source code here.

$3

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

$3

Run npm run generate and then npm run start.

$3

Run npm run build:lib.

$3

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

ng-zorro-antd is a good example of extending this package.