JGuang

图标

Icon · Ant Design

交互预览
npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

图标

语义化的矢量图形。

使用方法

使用图标组件,你需要安装 @ant-design/icons 图标组件包:

npm install @ant-design/icons@6.3.4

:::info{title=温馨提示} 使用 antd@6.x 版本时, 请确保安装配套的 @ant-design/icons@6.x 版本,避免版本不匹配带来的 Context 问题。详见 #53275 :::

设计师专属

安装 Kitchen Sketch 插件 💎,就可以一键拖拽使用 Ant Design 和 Iconfont 的海量图标,还可以关联自有项目。

图标列表

图标指南包含原生图标用法示例。官网的全量图标搜索控件没有复制为新的设计系统组件;独立图标目录与此指南分开。

代码演示

  • 基本用法 · basic
  • 多色图标 · two-tone
  • 自定义图标 · custom
  • 使用 iconfont.cn · iconfont
  • 使用 iconfont.cn 的多个资源 · scriptUrl

API

从 4.0 开始,antd 不再内置 Icon 组件,请使用独立的包 @ant-design/icons。

通用图标

参数说明类型默认值版本全局配置
className设置图标的样式名string-×
rotate图标旋转角度(IE9 无效)number-×
spin是否有旋转动画booleanfalse×
style设置图标的样式,例如 fontSize 和 colorCSSProperties-×
twoToneColor仅适用双色图标。设置双色图标的主要颜色,或主要颜色和次要颜色string | [string, string]-×

其中我们提供了三种主题的图标,不同主题的 Icon 组件名为图标名加主题做为后缀。

import { StarOutlined, StarFilled, StarTwoTone } from '@ant-design/icons';

<StarOutlined />
<StarFilled />
<StarTwoTone twoToneColor="#eb2f96" />

自定义 Icon

参数说明类型默认值版本全局配置
component控制如何渲染图标,通常是一个渲染根标签为 <svg> 的 React 组件ComponentType<CustomIconComponentProps>-×
rotate图标旋转角度(IE9 无效)number-×
spin是否有旋转动画booleanfalse×
style设置图标的样式,例如 fontSize 和 colorCSSProperties-×

关于 SVG 图标

在 3.9.0 之后,我们使用了 SVG 图标替换了原先的 font 图标,从而带来了以下优势:

  • 完全离线化使用,不需要从 CDN 下载字体文件,图标不会因为网络问题呈现方块,也无需字体文件本地部署。
  • 在低端设备上 SVG 有更好的清晰度。
  • 支持多色图标。
  • 对于内建图标的更换可以提供更多 API,而不需要进行样式覆盖。

更多讨论可参考:#10353。

所有的图标都会以 <svg> 标签渲染,可以使用 style 和 className 设置图标的大小和单色图标的颜色。例如:

import { MessageOutlined } from '@ant-design/icons';

<MessageOutlined style={{ fontSize: '16px', color: '#08c' }} />;

双色图标主色

对于双色图标,可以通过使用 getTwoToneColor() 和 setTwoToneColor(colorString) 来全局设置图标主色。

import { getTwoToneColor, setTwoToneColor } from '@ant-design/icons';

setTwoToneColor('#eb2f96');
getTwoToneColor(); // #eb2f96

自定义 font 图标

在 3.9.0 之后,我们提供了一个 createFromIconfontCN 方法,方便开发者调用在 iconfont.cn 上自行管理的图标。

import React from 'react';
import { createFromIconfontCN } from '@ant-design/icons';
import ReactDOM from 'react-dom/client';

const MyIcon = createFromIconfontCN({
  scriptUrl: '//at.alicdn.com/t/font_8d5l8fzk5b87iudi.js', // 在 iconfont.cn 上生成
});

ReactDOM.createRoot(mountNode).render(<MyIcon type="icon-example" />);

其本质上是创建了一个使用 <use> 标签来渲染图标的组件。

options 的配置项如下:

参数说明类型默认值版本全局配置
extraCommonProps给所有的 svg 图标 <Icon /> 组件设置额外的属性{ [key: string]: any }{}×
scriptUrliconfont.cn 项目在线生成的 js 地址,@ant-design/icons@4.1.0 之后支持 string[] 类型string | string[]-×

在 scriptUrl 都设置有效的情况下,组件在渲染前会自动引入 iconfont.cn 项目中的图标符号集,无需手动引入。

见 iconfont.cn 使用帮助 查看如何生成 js 地址。

自定义 SVG 图标

如果使用 webpack,可以通过配置 @svgr/webpack 来将 svg 图标作为 React 组件导入。@svgr/webpack 的 options 选项请参阅 svgr 文档。

// webpack.config.js
module.exports = {
  // ... other config
  test: /\.svg(\?v=\d+\.\d+\.\d+)?$/,
  use: [
    {
      loader: 'babel-loader',
    },
    {
      loader: '@svgr/webpack',
      options: {
        babel: false,
        icon: true,
      },
    },
  ],
};

如果使用 vite,可以通过配置 vite-plugin-svgr 来将 svg 图标作为 React 组件导入。vite-plugin-svgr 的 options 选项请参阅 svgr 文档。

// vite.config.js
export default defineConfig(() => ({
  // ... other config
  plugins: [svgr({ svgrOptions: { icon: true } })],
}));
import React from 'react';
import Icon from '@ant-design/icons';
import MessageSvg from 'path/to/message.svg'; // 你的 '*.svg' 文件路径

// import MessageSvg from 'path/to/message.svg?react'; // 使用vite 你的 '*.svg?react' 文件路径.
import ReactDOM from 'react-dom/client';

// in create-react-app:
// import { ReactComponent as MessageSvg } from 'path/to/message.svg';

ReactDOM.createRoot(mountNode).render(<Icon component={MessageSvg} />);

Icon 中的 component 组件的接受的属性如下:

字段说明类型只读值版本全局配置
className计算后的 svg 类名string-×
fillsvg 元素填充的颜色stringcurrentColor×
heightsvg 元素高度string | number1em×
style计算后的 svg 元素样式CSSProperties-×
widthsvg 元素宽度string | number1em×

主题变量(Design Token)

固定源码中没有此组件的独立 ComponentToken 声明。样式遵循原生全局令牌或所组合组件的令牌;不额外推断字段和默认值。

FAQ

为什么有时 icon 注入的样式会引起全局样式异常?

相关 issue:#54391

启用 layer 时,icon 的样式可能会使 @layer antd 优先级降低,并导致所有组件样式异常。

这个问题可以通过以下两步解决:

  1. 使用 @ant-design/icons@6.x 配合 antd@6.x。
  2. 停止使用 message, Modal 和 notification 的静态方法,改为使用 hooks 版本或 App 提供的实例。

如果无法避免使用静态方法,可以在 App 组件下立刻使用任一一个 icon 组件,以规避静态方法对样式的影响。

<StyleProvider layer>
  <ConfigProvider>
    <App>
+     {/* any icon */}
+     <RightOutlined />
      {/* your pages */}
    </App>
  </ConfigProvider>
</StyleProvider>

原生通用属性

Tips: 以下通用属性适用于 antd 大部分组件,不支持的组件会单独说明。

参数说明类型默认值
style自定义样式CSSProperties-
className自定义类名string-
rootClassName添加在组件最外层的 classNamestring-
autoFocus自动获取焦点,仅对表单类、链接、交互容器等可聚焦元素生效booleanfalse

安装并复现示例

npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

使用 ConfigProvider 和原生 App,并单独配置 dayjs 语言。每个示例在查看代码中列出完整源码文件和额外固定依赖。示例名称用于选择演示,不是组件通用属性。主题、语言与 SSR 初始化见资源安装指南。

原生类型参考

源码查看器包含未修改的原生实现和以下声明文件,继承类型仍位于原生包中。代码中的英文注释保留为源码参考。

  • npm/@ant-design/icons@6.3.4/es/components/Icon.d.ts

来源与许可

https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd

保留原生中英文正文与可执行示例;官网专用的嵌入章节和令牌表格在本地展开。Ant Design 使用 MIT 许可,另列依赖的许可证也需保留。上传预览禁止向外发起请求,不提供后端服务。