Icon图标 - 图1

Icon 图标

语义化的矢量图形。使用图标组件,你需要安装 @ant-design/icons-vue 图标组件包:

  1. npm install --save @ant-design/icons-vue

设计师专属

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

代码演示

选择图标主题风格

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

方向性图标

Icon图标 - 图5

提示建议性图标

Icon图标 - 图6

编辑类图标

Icon图标 - 图7

数据类图标

Icon图标 - 图8

品牌和标识

Icon图标 - 图9

网站通用图标

Icon图标 - 图10

Icon图标 - 图11

基本用法

通过 @ant-design/icons-vue 引用 Icon 组件,不同主题的 Icon 组件名为图标名加主题做为后缀,也可以通过设置 spin 属性来实现动画旋转效果。

  1. <template>
  2. <div class="icons-list">
  3. <HomeOutlined />
  4. <SettingFilled />
  5. <SmileOutlined />
  6. <SyncOutlined spin />
  7. <SmileOutlined :rotate="180" />
  8. <LoadingOutlined />
  9. </div>
  10. </template>
  11. <script lang="ts">
  12. import { defineComponent } from 'vue';
  13. import {
  14. HomeOutlined,
  15. SettingFilled,
  16. SmileOutlined,
  17. SyncOutlined,
  18. LoadingOutlined,
  19. } from '@ant-design/icons-vue';
  20. export default defineComponent({
  21. components: {
  22. HomeOutlined,
  23. SettingFilled,
  24. SmileOutlined,
  25. SyncOutlined,
  26. LoadingOutlined,
  27. },
  28. });
  29. </script>
  30. <style scoped>
  31. .icons-list :deep(.anticon) {
  32. margin-right: 6px;
  33. font-size: 24px;
  34. }
  35. </style>

Icon图标 - 图12

自定义图标

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

  1. <template>
  2. <div class="custom-icons-list">
  3. <Icon :style="{ color: 'hotpink' }">
  4. <template #component>
  5. <svg width="1em" height="1em" fill="currentColor" viewBox="0 0 1024 1024">
  6. <path
  7. 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"
  8. />
  9. </svg>
  10. </template>
  11. </Icon>
  12. <Icon :style="{ fontSize: '32px' }">
  13. <template #component="svgProps">
  14. <svg viewBox="0 0 1024 1024" width="1em" height="1em" fill="currentColor" v-bind="svgProps">
  15. <path
  16. 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"
  17. fill="#6B676E"
  18. p-id="1143"
  19. />
  20. <path
  21. 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"
  22. fill="#FFEBD2"
  23. p-id="1144"
  24. />
  25. <path
  26. d="M330.324 842.126c0 82.096 81.34 148.646 181.678 148.646s181.678-66.55 181.678-148.646H330.324z"
  27. fill="#E9D7C3"
  28. p-id="1145"
  29. />
  30. <path
  31. 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"
  32. fill="#FFFFFF"
  33. p-id="1146"
  34. />
  35. <path
  36. 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"
  37. fill="#6B676E"
  38. p-id="1147"
  39. />
  40. <path
  41. 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"
  42. fill="#464655"
  43. p-id="1148"
  44. />
  45. <path
  46. 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"
  47. fill="#464655"
  48. p-id="1149"
  49. />
  50. <path
  51. 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"
  52. fill="#464655"
  53. p-id="1150"
  54. />
  55. </svg>
  56. </template>
  57. </Icon>
  58. </div>
  59. </template>
  60. <script lang="ts">
  61. import { defineComponent } from 'vue';
  62. import Icon from '@ant-design/icons-vue';
  63. export default defineComponent({
  64. components: {
  65. Icon,
  66. },
  67. });
  68. </script>
  69. <style scoped>
  70. .custom-icons-list :deep(.anticon) {
  71. margin-right: 6px;
  72. }
  73. </style>

Icon图标 - 图13

多色图标

双色图标可以通过 twoToneColor 属性设置主题色。

  1. <template>
  2. <div class="icons-list">
  3. <SmileTwoTone />
  4. <HeartTwoTone twoToneColor="#eb2f96" />
  5. <CheckCircleTwoTone twoToneColor="#52c41a" />
  6. </div>
  7. </template>
  8. <script>
  9. import { SmileTwoTone, HeartTwoTone, CheckCircleTwoTone } from '@ant-design/icons-vue';
  10. export default {
  11. components: {
  12. SmileTwoTone,
  13. HeartTwoTone,
  14. CheckCircleTwoTone,
  15. },
  16. };
  17. </script>
  18. <style scoped>
  19. .icons-list :deep(.anticon) {
  20. margin-right: 6px;
  21. font-size: 24px;
  22. }
  23. </style>

Icon图标 - 图14

使用 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 { createFromIconfontCN } from '@ant-design/icons-vue';
  10. const IconFont = 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 :deep(.anticon) {
  21. margin-right: 6px;
  22. font-size: 24px;
  23. }
  24. </style>

API

通用图标

参数说明类型默认值版本
style设置图标的样式,例如 fontSizecolorCSSProperties-
spin是否有旋转动画booleanfalse
rotate图标旋转角度(IE9 无效)number-
twoToneColor仅适用双色图标。设置双色图标的主要颜色string (十六进制颜色)-

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

  1. import { StarOutlined, StarFilled, StarTwoTone } from '@ant-design/icons-vue';
  2. <StarOutlined />
  3. <StarFilled />
  4. <StarTwoTone twoToneColor="#eb2f96" />

自定义 Icon/Custom Icon

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

SVG 图标

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

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

更多讨论可参考:#10353

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

  1. <template>
  2. <MessageOutlined :style="{fontSize: '16px', color: '#08c'}" />
  3. </template>
  4. <script>
  5. import { MessageOutlined } from '@ant-design/icons-vue';
  6. import { defineComponent } from 'vue';
  7. export default defineComponent({
  8. components: {
  9. MessageOutlined,
  10. },
  11. });
  12. </script>

双色图标主色

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

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

自定义 font 图标

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

  1. import { createFromIconfontCN } from '@ant-design/icons-vue';
  2. import { defineComponent } from 'vue';
  3. const MyIcon = createFromIconfontCN({
  4. scriptUrl: '//at.alicdn.com/t/font_8d5l8fzk5b87iudi.js', // 在 iconfont.cn 上生成
  5. });
  6. export default defineComponent({
  7. setup() {
  8. return () => <MyIcon type="icon-dianzan" />;
  9. },
  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 { defineComponent } from 'vue';
  2. import Icon from '@ant-design/icons-vue';
  3. import MessageSvg from 'path/to/message.svg'; // '*.svg' 文件的路径
  4. export default defineComponent({
  5. setup() {
  6. return () => <Icon type={MessageSvg} />;
  7. },
  8. });

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

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