Icon
Import |
Source |
Docs |
List of icons#
We keep in syncing with antd.
Select the Icon Theme
Directional Icons
StepBackward StepForward FastBackward FastForward Shrink ArrowsAlt Down Up Left Right CaretUp CaretDown CaretLeft CaretRight UpCircle DownCircle LeftCircle RightCircle DoubleRight DoubleLeft VerticalLeft VerticalRight VerticalAlignTop VerticalAlignMiddle VerticalAlignBottom Forward Backward Rollback Enter Retweet Swap SwapLeft SwapRight ArrowUp ArrowDown ArrowLeft ArrowRight PlayCircle UpSquare DownSquare LeftSquare RightSquare Login Logout MenuFold MenuUnfold BorderBottom BorderHorizontal BorderInner BorderOuter BorderLeft BorderRight BorderTop BorderVerticle PicCenter PicLeft PicRight RadiusBottomleft RadiusBottomright RadiusUpleft RadiusUpright Fullscreen FullscreenExit
Suggested Icons
Question QuestionCircle Plus PlusCircle Pause PauseCircle Minus MinusCircle PlusSquare MinusSquare Info InfoCircle Exclamation ExclamationCircle Close CloseCircle CloseSquare Check CheckCircle CheckSquare ClockCircle Warning IssuesClose Stop
Editor Icons
Edit Form Copy Scissor Delete Snippets Diff Highlight AlignCenter AlignLeft AlignRight BgColors Bold Italic Underline Strikethrough Redo Undo ZoomIn ZoomOut FontColors FontSize LineHeight Dash SmallDash SortAscending SortDescending Drag OrderedList UnorderedList RadiusSetting ColumnWidth ColumnHeight
Data Icons
AreaChart PieChart BarChart DotChart LineChart RadarChart HeatMap Fall Rise Stock BoxPlot Fund Sliders
Brand and Logos
Android Apple Windows Linux Ie Chrome Github Aliwangwang Dingding Dingtalk WeiboSquare WeiboCircle Weibo Taobao TaobaoCircle Twitter Wechat Youtube AlipayCircle Skype Qq MediumWorkmark Gitlab Medium Linkedin GooglePlus Dropbox Facebook Html5 Java JavaScript Python Docker Kubernetes Ruby DotNet Codepen CodeSandbox Amazon Google CodepenCircle Alipay AntDesign AntCloud Aliyun Zhihu Slack SlackSquare Behance BehanceSquare Dribbble DribbbleSquare Instagram Yuque Alibaba Yahoo Reddit Discord Sketch Baidu Bilibili HarmonyOS OpenAI Pinterest Spotify TikTok Twitch WechatWork WhatsApp X
Application Icons
Aim AccountBook Alert Apartment Api AppstoreAdd Appstore AudioMuted Audio Audit Bank Bars Barcode Bell Book Block BorderlessTable Border Bug Build Branches Bulb Calculator Calendar Camera Car CarryOut CiCircle Clear Ci Cloud CloudSync CloudUpload Cluster CloudServer CloudDownload Code Coffee Compass Comment Compress Contacts ConsoleSql Container CopyrightCircle Copyright Crown Control CreditCard CustomerService Database Dashboard DeleteColumn DeleteRow Desktop DeploymentUnit DeliveredProcedure Disconnect Dislike DollarCircle Dollar Download Ellipsis Environment Euro Exception EuroCircle Experiment ExpandAlt Expand Export Eye EyeInvisible FieldNumber FileAdd FieldString FileDone FieldTime FieldBinary FileExcel FileExclamation FileGif FileJpg FileImage FileMarkdown FilePdf File FileSearch FileSync FileProtect FilePpt FileText FileZip FileUnknown Filter FileWord Fire Flag FolderAdd FolderOpen Folder Fork Frown FolderView FormatPainter FundProjectionScreen FundView Function Gateway Gif Global FunnelPlot Gift Gold Group Heart Hdd Home History Holder Hourglass Idcard Import Inbox InsertRowAbove InsertRowLeft InsertRowRight InsertRowBelow Insurance Interaction Key Laptop Layout Line Link Like Loading Lock MacCommand Mail Loading3Quarters Man MedicineBox Menu Meh MergeCells Merge - Message
Mobile Monitor More Moon MoneyCollect NodeExpand Muted NodeCollapse Notification NodeIndex Number OneToOne PaperClip Percentage PayCircle Partition Phone Picture PlaySquare PoundCircle Poweroff Pound Product Printer Profile Project Pushpin PropertySafety PullRequest Qrcode Reconciliation Read RedEnvelope Reload Rest Robot Rocket RotateRight RotateLeft SafetyCertificate Safety Save Scan Select SecurityScan Setting Schedule Send Shop Search ShareAlt ShoppingCart Shake Shopping Sisternode Signature Skin Smile Solution Sound SplitCells Star Subnode Switcher Sun Table Sync Tablet Tag Tags Team Thunderbolt ToTop Tool TrademarkCircle Trademark Transaction Trophy Translation Truck Ungroup Unlock Upload User UserAdd Usb UsergroupAdd UsergroupDelete UserDelete UserSwitch Wallet Verified VideoCameraAdd VideoCamera Wifi Woman
Examples #
Loading...
Loading...
Loading...
Loading...
Loading...
API#
nz-icon, [nz-icon]#
| Property | Description | Type | Default | Global Config |
|---|---|---|---|---|
[nzType] | Type of the ant design icon | string | - | - |
[nzTheme] | Type of the ant design icon | 'fill'|'outline'|'twotone' | 'outline' | ✅ |
[nzSpin] | Rotate icon with animation | boolean | false | - |
[nzTwotoneColor] | Primary color of the two-tone icon. | string (hex color) | - | ✅ |
[nzIconfont] | Type of the icon from iconfont | string | - | - |
[nzRotate] | Rotate degrees | number | - | - |
NzIconService#
| Methods | Description | Parameters |
|---|---|---|
addIcon() | To import icons statically | IconDefinition |
addIconLiteral() | To statically import custom icons | string, string (SVG) |
fetchFromIconfont() | To get icon assets from iconfont | NzIconfontOption |
changeAssetsSource() | Change the location of your icon assets, so that you can deploy them anywhere | string |
SVG icons#
NG-ZORRO supports svg icons, which bring benefits below:
- Support multiple colors.
- Much more display accuracy in lower-level devices.
- Able to change built-in icons with more props but no styles override.
You can use nz-icon component and specify the theme property.
<nz-icon nzType="star" nzTheme="fill" />
Static loading and dynamic loading#
As for icons provided by Ant Design, there are two ways to import them into your project.
Static loading. You can load icons statically by registering icons in app.config.ts with provideNzIcons API.
import { IconDefinition } from '@ant-design/icons-angular';
import { provideNzIcons } from 'ng-zorro-antd/icon';
// Import what you need. RECOMMENDED. ✔️
import { AccountBookFill, AlertFill, AlertOutline } from '@ant-design/icons-angular/icons';
const icons: IconDefinition[] = [AccountBookFill, AlertOutline, AlertFill];
// Import all. NOT RECOMMENDED. ❌
// import * as AllIcons from '@ant-design/icons-angular/icons';
// const antDesignIcons = AllIcons as Record<string, IconDefinition>;
// const icons: IconDefinition[] = Object.keys(antDesignIcons).map(key => antDesignIcons[key])
export const appConfig: ApplicationConfig = {
providers: [provideNzIcons(icons)]
};
Actually this calls addIcon of NzIconService. Imported icons would be bundled into your .js files.
Static loading may increase your bundle size, thus we recommend to use dynamic importing.
Icons used by
NG-ZORROitself are imported statically to increase loading speed. However, icons demonstrated on the official website are loaded dynamically.
Dynamic loading. This way would not increase your bundle size. When NG-ZORRO detects that the icon you want to
render hasn't been registered yet, it would fire an HTTP request to load it. All you have to do is to config your
angular.json like this:
{
"assets": [
{
"glob": "**/*",
"input": "./node_modules/@ant-design/icons-angular/src/inline-svg/",
"output": "/assets/"
}
]
}
You can call changeAssetsSource() of NzIconService to change the location of your icon assets, so that you can
deploy the assets to CDN. The parameter you passed would be added in front of assets/.
Assume that you deploy the static assets under https://mycdn.somecdn.com/icons/assets. You can call
changeAssetsSource('https://mycdn.somecdn.com/icons') to tell NG-ZORRO that all your resources are located there.
Add Icons in Lazy-loaded Components#
Sometimes, you want to import icons in lazy components to avoid increasing the size of the main.js.
You can import icons in providers of the component or router with provideNzIconsPatch API.
import { NzIconModule, provideNzIconsPatch } from 'ng-zorro-antd/icon';
// in xxx.component.ts
@Component({
imports: [NzIconModule],
providers: [provideNzIconsPatch([QuestionOutline])]
})
class ChildComponent {}
// or in xxx.routes.ts
const routes: Routes = [
{
path: '',
providers: [provideNzIconsPatch([QuestionOutline])]
}
];
Once the QuestionOutline icon get loaded, it would be usable across the application.
Set Default TwoTone Color#
When using two-tone icons, you should provide a global configuration like { nzIcon: { nzTwotoneColor: 'xxx' } } via NzConfigService or call corresponding set method to change to default twotone color.
Custom Font Icon#
We provided a fetchFromIconfont method, which is specified for iconfont, to help you use your own icons deployed at iconfont.cn in a convenient way.
this._iconService.fetchFromIconfont({
scriptUrl: 'https://at.alicdn.com/t/font_8d5l8fzk5b87iudi.js'
});
And then you can use it like this:
<nz-icon nzIconfont="icon-tuichu" />
It creates a component that uses SVG sprites in essence.
The following options are available:
| Property | Description | Type | Default |
|---|---|---|---|
scriptUrl | The URL generated by iconfont.cn project. | string | - |
The property scriptUrl should be set to import the svg sprite symbols.
See iconfont.cn document to learn about how to generate the scriptUrl.
Namespace#
We introduced namespace so you could add your own icons in a convenient way.
When you want to render an icon, you could assign typenamespace:name. Dynamic importing and static importing are both supported.
Static importing. Invoke addIconLiteral of NzIconService.
Dynamic importing. Make sure that you have put your SVG resources in directory like assets/${namespace}.
For example, if you have a panda icon and in zoo namespace, you should put the file panda.svg in assets/zoo.
FAQ#
All my icons are gone!#
Have you ever read the docs above?
There are two similar icons in a <span></span> tag. What happened?#
In older versions of NG-ZORRO, there was a font file which would use :before to insert an icon according to a <i> tag's class.
So if you have two icons, try to remove node_modules and install again. If the problem is still there, search @icon-url and remove that line.
I want to import all icons statically. What should I do?#
Although it is not recommended, actually we demonstrate it at section Static loading and dynamic loading:
import * as AllIcons from '@ant-design/icons-angular/icons';
const antDesignIcons = AllIcons as Record<string, IconDefinition>;
const icons: IconDefinition[] = Object.keys(antDesignIcons).map(key => antDesignIcons[key]);
Does dynamic loading affect web pages' performance?#
We used several methods to reduce requests, such as static cache, dynamic cache and reusable request. It's basically not noticeable for visitors that icons are loaded asynchronously assuming web connections are fairly good.
How do I know an icon's corresponding module to import?#
Capital camel-case type & theme, i.e. alibaba => AlibabaOutline.