图标 Icon

语义化的矢量图形。

设计师专属

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

图标列表

选择图标主题风格

Icon图标 - 图1 线框风格 Icon图标 - 图2 实底风格 Icon图标 - 图3 双色风格

Icon图标 - 图4

方向性图标

Icon图标 - 图5

提示建议性图标

Icon图标 - 图6

编辑类图标

Icon图标 - 图7

数据类图标

Icon图标 - 图8

品牌和标识

Icon图标 - 图9

网站通用图标

Icon图标 - 图10

Icon图标 - 图11

基本用法

使用 <Icon/> 标签声明组件,指定图标对应的 type 属性。可以通过 theme 属性来设置不同的主题风格的图标,也可以通过设置 spin 属性来实现动画旋转效果。

  1. <template>
  2. <div class="icons-list">
  3. <a-icon type="home" />
  4. <a-icon type="setting" theme="filled" />
  5. <a-icon type="smile" theme="outlined" />
  6. <a-icon type="sync" spin />
  7. <a-icon type="smile" :rotate="180" />
  8. <a-icon type="loading" />
  9. </div>
  10. </template>
  11. <style scoped>
  12. .icons-list >>> .anticon {
  13. margin-right: 6px;
  14. font-size: 24px;
  15. }
  16. </style>

Icon图标 - 图12

自定义图标

利用 Icon 组件封装一个可复用的自定义图标。可以通过 component 属性传入一个组件来渲染最终的图标,以满足特定的需求。

  1. <template>
  2. <div class="custom-icons-list">
  3. <heart-icon :style="{ color: 'hotpink' }" />
  4. <panda-icon :style="{ fontSize: '32px' }" />
  5. </div>
  6. </template>
  7. <script>
  8. const HeartSvg = {
  9. template: `
  10. <svg width="1em" height="1em" fill="currentColor" viewBox="0 0 1024 1024">
  11. <path d="M923 283.6c-13.4-31.1-32.6-58.9-56.9-82.8-24.3-23.8-52.5-42.4-84-55.5-32.5-13.5-66.9-20.3-102.4-20.3-49.3 0-97.4 13.5-139.2 39-10 6.1-19.5 12.8-28.5 20.1-9-7.3-18.5-14-28.5-20.1-41.8-25.5-89.9-39-139.2-39-35.5 0-69.9 6.8-102.4 20.3-31.4 13-59.7 31.7-84 55.5-24.4 23.9-43.5 51.7-56.9 82.8-13.9 32.3-21 66.6-21 101.9 0 33.3 6.8 68 20.3 103.3 11.3 29.5 27.5 60.1 48.2 91 32.8 48.9 77.9 99.9 133.9 151.6 92.8 85.7 184.7 144.9 188.6 147.3l23.7 15.2c10.5 6.7 24 6.7 34.5 0l23.7-15.2c3.9-2.5 95.7-61.6 188.6-147.3 56-51.7 101.1-102.7 133.9-151.6 20.7-30.9 37-61.5 48.2-91 13.5-35.3 20.3-70 20.3-103.3 0.1-35.3-7-69.6-20.9-101.9z" />
  12. </svg>
  13. `,
  14. };
  15. const PandaSvg = {
  16. template: `
  17. <svg viewBox="0 0 1024 1024" width="1em" height="1em" fill="currentColor">
  18. <path d="M99.096 315.634s-82.58-64.032-82.58-132.13c0-66.064 33.032-165.162 148.646-148.646 83.37 11.91 99.096 165.162 99.096 165.162l-165.162 115.614zM924.906 315.634s82.58-64.032 82.58-132.13c0-66.064-33.032-165.162-148.646-148.646-83.37 11.91-99.096 165.162-99.096 165.162l165.162 115.614z" fill="#6B676E" p-id="1143" />
  19. <path d="M1024 561.548c0 264.526-229.23 429.42-512.002 429.42S0 826.076 0 561.548 283.96 66.064 512.002 66.064 1024 297.022 1024 561.548z" fill="#FFEBD2" p-id="1144" />
  20. <path d="M330.324 842.126c0 82.096 81.34 148.646 181.678 148.646s181.678-66.55 181.678-148.646H330.324z" fill="#E9D7C3" p-id="1145" />
  21. <path d="M644.13 611.098C594.582 528.516 561.55 512 512.002 512c-49.548 0-82.58 16.516-132.13 99.096-42.488 70.814-78.73 211.264-49.548 247.742 66.064 82.58 165.162 33.032 181.678 33.032 16.516 0 115.614 49.548 181.678-33.032 29.18-36.476-7.064-176.93-49.55-247.74z" fill="#FFFFFF" p-id="1146" />
  22. <path d="M611.098 495.484c0-45.608 36.974-82.58 82.58-82.58 49.548 0 198.194 99.098 198.194 165.162s-79.934 144.904-148.646 99.096c-49.548-33.032-132.128-148.646-132.128-181.678zM412.904 495.484c0-45.608-36.974-82.58-82.58-82.58-49.548 0-198.194 99.098-198.194 165.162s79.934 144.904 148.646 99.096c49.548-33.032 132.128-148.646 132.128-181.678z" fill="#6B676E" p-id="1147" />
  23. <path d="M512.002 726.622c-30.06 0-115.614 5.668-115.614 33.032 0 49.638 105.484 85.24 115.614 82.58 10.128 2.66 115.614-32.944 115.614-82.58-0.002-27.366-85.556-33.032-115.614-33.032z" fill="#464655" p-id="1148" />
  24. <path d="M330.324 495.484m-33.032 0a33.032 33.032 0 1 0 66.064 0 33.032 33.032 0 1 0-66.064 0Z" fill="#464655" p-id="1149" />
  25. <path d="M693.678 495.484m-33.032 0a33.032 33.032 0 1 0 66.064 0 33.032 33.032 0 1 0-66.064 0Z" fill="#464655" p-id="1150" />
  26. </svg>
  27. `,
  28. };
  29. const HeartIcon = {
  30. template: `
  31. <a-icon :component="HeartSvg" />
  32. `,
  33. data() {
  34. return {
  35. HeartSvg,
  36. };
  37. },
  38. };
  39. const PandaIcon = {
  40. template: `
  41. <a-icon :component="PandaSvg" />
  42. `,
  43. data() {
  44. return {
  45. PandaSvg,
  46. };
  47. },
  48. };
  49. export default {
  50. components: {
  51. HeartIcon,
  52. PandaIcon,
  53. },
  54. };
  55. </script>
  56. <style scoped>
  57. .custom-icons-list >>> .anticon {
  58. margin-right: 6px;
  59. }
  60. </style>

Icon图标 - 图13

使用 iconfont.cn

对于使用 iconfont.cn 的用户,通过设置 createFromIconfontCN 方法参数对象中的 scriptUrl 字段, 即可轻松地使用已有项目中的图标。

  1. <template>
  2. <div class="icons-list">
  3. <icon-font type="icon-tuichu" />
  4. <icon-font type="icon-facebook" />
  5. <icon-font type="icon-twitter" />
  6. </div>
  7. </template>
  8. <script>
  9. import { Icon } from 'ant-design-vue';
  10. const IconFont = Icon.createFromIconfontCN({
  11. scriptUrl: '//at.alicdn.com/t/font_8d5l8fzk5b87iudi.js',
  12. });
  13. export default {
  14. components: {
  15. IconFont,
  16. },
  17. };
  18. </script>
  19. <style scoped>
  20. .icons-list >>> .anticon {
  21. margin-right: 6px;
  22. font-size: 24px;
  23. }
  24. </style>

Icon图标 - 图14

多色图标

可以通过设置 theme 属性为 twoTone 来渲染双色图标,并且可以设置主题色。

  1. <template>
  2. <div class="icons-list">
  3. <a-icon type="smile" theme="twoTone" />
  4. <a-icon type="heart" theme="twoTone" two-tone-color="#eb2f96" />
  5. <a-icon type="check-circle" theme="twoTone" two-tone-color="#52c41a" />
  6. </div>
  7. </template>
  8. <style scoped>
  9. .icons-list >>> .anticon {
  10. margin-right: 6px;
  11. font-size: 24px;
  12. }
  13. </style>

API

参数说明类型默认值
type图标类型。遵循图标的命名规范string-
style设置图标的样式,例如 fontSizecolorCSSProperties-
theme图标主题风格。可选实心、描线、双色等主题风格,适用于官方图标‘filled’ | ‘outlined’ | ‘twoTone’‘outlined’
spin是否有旋转动画booleanfalse
rotate图标旋转角度(1.4.0 后新增,IE9 无效)number-
component控制如何渲染图标,通常是一个渲染根标签为 <svg>Vue 组件,会使 type 属性失效ComponentType<CustomIconComponentProps>-
twoToneColor仅适用双色图标。设置双色图标的主要颜色string (十六进制颜色)-

注意:Icon 组件中图标渲染的优先级为 component > children > type, 传入 props 时,优先级高的直接生效,优先级低的则失效。

SVG 图标

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

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

更多讨论可参考:#10353

⚠️ 1.2.0 之后我们全量引入了所有图标,导致 ant-design-vue 默认的包体积有一定增加,我们会在不远的未来增加新的 API 来实现图标的按需使用,更多相关讨论可关注:#12011。在此之前,你可以通过来自社区同学的 webpack 插件将图标文件拆分。

其中 theme, component, twoToneColor1.2.x 版本新增加的属性。最佳实践是给使用的 <Icon /> 组件传入属性 theme 以明确图标的主题风格。例如:

  1. <a-icon type="star" theme="filled" />

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

  1. <a-icon type="message" :style="{ fontSize: '16px', color: '#08c' }" />

双色图标主色

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

  1. import { Icon } from 'ant-design-vue';
  2. Icon.setTwoToneColor('#eb2f96');
  3. Icon.getTwoToneColor(); // #eb2f96

自定义 font 图标

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

  1. const MyIcon = Icon.createFromIconfontCN({
  2. scriptUrl: '//at.alicdn.com/t/font_8d5l8fzk5b87iudi.js', // 在 iconfont.cn 上生成
  3. });
  4. new Vue({
  5. el: '#app',
  6. components: {
  7. 'my-icon': MyIcon,
  8. },
  9. template: '<my-icon type="icon-example" />',
  10. });

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

options 的配置项如下:

参数说明类型默认值
scriptUrliconfont.cn 项目在线生成的 js 地址string-
extraCommonProps给所有的 svg 图标 <Icon /> 组件设置额外的属性{ class, attrs, props, on, style }{}

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

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

自定义 SVG 图标

如果使用 vue cli 3,可以通过配置 vue-svg-loader 来将 svg 图标作为 Vue 组件导入。更多vue-svg-loader 的使用方式请参阅 文档

  1. // vue.config.js
  2. module.exports = {
  3. chainWebpack: config => {
  4. const svgRule = config.module.rule('svg');
  5. svgRule.uses.clear();
  6. svgRule.use('vue-svg-loader').loader('vue-svg-loader');
  7. },
  8. };
  1. import MessageSvg from 'path/to/message.svg'; // path to your '*.svg' file.
  2. new Vue({
  3. el: '#app',
  4. data() {
  5. return {
  6. MessageSvg,
  7. };
  8. },
  9. template: '<a-icon :component="MessageSvg" />',
  10. });

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

字段说明类型只读值
widthsvg 元素宽度string | number‘1em’
heightsvg 元素高度string | number‘1em’
fillsvg 元素填充的颜色string‘currentColor’
class计算后的 svg 类名string-
style计算后的 svg 元素样式CSSProperties-