Vue3 中使用iconfont svg图标

Vue3使用一段时间以后，感觉比Vue2版本提升很多。下面记录一下如何在Vite+Vue3项目中无痛使用任何类型的svg图标。

1. 安装vbenjs/vite-plugin-svg-icons: Vite Plugin for fast creating SVG sprites. (github.com)
   这个组件的作用是把多个svg生成雪碧图方便调用

2. vite.config.js设置，注意更换为你自己的svg文件夹路径

import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import path from 'path';
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons';
 plugins: [
    vue(),
    //svg
    createSvgIconsPlugin({
      // 指定需要缓存的图标文件夹
      iconDirs: [path.resolve(process.cwd(), 'src/assets/svg')],
      // 指定symbolId格式
      symbolId: 'icon-[dir]-[name]',

      /**
       * 自定义插入位置
       * @default: body-last
       */
      inject: 'body-last' | 'body-first',

      /**
       * custom dom id
       * @default: __svg__icons__dom__
       */
      customDomId: '__svg__icons__dom__'
    })
  ],

3. 写一个SvgIcon组件：

<template>
  <svg aria-hidden="true" :class="svgClass" :style="styleObject" @click="emit('on-click')">
    <use :xlink:href="symbolId" :fill="color" :stroke="color" />
  </svg>
</template>

<script>
export default {
  name: 'SvgIcon'
};
</script>

<script setup>
import { computed } from 'vue';
const props = defineProps({
  prefix: {
    type: String,
    default: 'icon'
  },
  name: {
    type: String,
    required: true
  },
  color: {
    type: String,
    default: '#fff'
  },
  clickable: {
    type: Boolean,
    default: false
  },
  size: {
    type: String,
    default: '1em'
  },
  className: {
    type: String,
    default: ''
  }
});
const symbolId = computed(() => `#${props.prefix}-${props.name}`);
const svgClass = computed(() => 'svg-icon ' + props.className || '');
const styleObject = computed(() => {
  return {
    width: props.size,
    height: props.size,
    cursor: props.clickable ? 'pointer' : ''
  };
});
const emit = defineEmits(['on-click']);
</script>

4. main.js中注册此全局组件

//引入svg
import { createApp } from 'vue';
import App from './App.vue';
import 'virtual:svg-icons-register'; //这一句必须要加上
import SvgIcon from './components/SvgIcon.vue';

createApp(App).component('SvgIcon', SvgIcon).use(router).mount('#app');

5.直接下载svg至前面设定的文件夹下
svg文件不一定从iconfont下载，任何地方的都可以，保存在'src/assets/svg'目录下

6. 使用

  <SvgIcon :name="svg文件名（不带后缀）" color="#93c5fd" size="3em"></SvgIcon>