vite+vue3+ts在项目中优雅的使用svg

需求：在项目开发中，我们会使用到很多的图标，有些图标可以直接取UI组件库的，有些是ui设计师蓝湖裁剪的icon，或者开发中在其他图标库下载的图标等等。兼容能使用svg图标，这里分享一下我的实现过程。

svg图标的生成

这里分享两种不同的实现方法。

使用插件vite

vite-plugin-svg-icons
安装vite-plugin-svg-icons

**node version:**  >=12.0.0
**vite version:**  >=2.0.0
yarn add vite-plugin-svg-icons -D
# or
npm i vite-plugin-svg-icons -D
# or
pnpm install vite-plugin-svg-icons -D

使用vite-plugin-svg-icons的优势

预加载 在项目运行时就生成所有图标,只需操作一次 dom
高性能 内置缓存,仅当文件被修改时才会重新生成

在vite-config.ts配置

import {createSvgIconsPlugin } from 'vite-plugin-svg-icons';
export default ({mode,command }:ConfigEnv):UserConfigExport=>{
  return defineConfig({
      plugins: [
          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__'
          }),
      ]
  })
}

在 src/main.ts 内引入注册脚本

import 'virtual:svg-icons-register';

自注册

自注册方法

// 导入所有的svg图标
// 完成SvgIconde 全局注册
import SvgIcon from '../components/SvgIcon/index.vue'
const svgRequire = require.context('./svg', false, /\.svg$/)
// 此时返回一个Require函数， 可以接受一个 request 的参数，用于require的导入
// 该函数提供了三个属性， 通过svgRequire.keys()获取所有的svg图标
// 遍历图标，把图标作为request参数导入到 svgRequire 导入函数中，完成本地svg图标。
svgRequire.keys().forEach(svgIcon => svgRequire(svgIcon))
// 注册
export default app => {
  app.component('svg-icon', SvgIcon)
}

全局注册

import installIcons from './icons/index.js'
const app = createApp(App)
installIcons(app)

svg组件

适用于vite-plugin-svg-icons插件注册

<template>
    <svg
        :class="svgClass"
        v-bind="$attrs"
        :style="{ color: color, width: w, height: h }"
    >
        <use :xlink:href="iconName"></use>
    </svg>
</template>

<script setup lang="ts">
const props = defineProps({
  name: {
    type: String,
    required: true,
  },
  color: {
    type: String,
    default: "",
  },
  w: {
    type: String,
    default: "1rem",
  },
  h: {
    type: String,
    default: "1rem",
  },
});
const iconName = computed(() => `#icon-${props.name}`);
const svgClass = computed(() => {
  if (props.name) return `svg-icon icon-${props.name}`;
  return "svg-icon";
});

</script>

<style scoped lang="scss">
.svg-icon {
  /* 此属性为更改svg颜色属性设置 */
  width: 1em;
  height: 1em;
  /* vertical-align: -0.15em; */
  overflow: hidden;
  fill: currentColor;
  vertical-align: middle;
}
</style>

适用于自注册

<template>
  <div
    v-if="isExternal"
    :style="styleExternalIcon"
    class="svg-external-icon svg-icon"
    :class="className"></div>
  <svg v-else class="svg-icon" :class="className" aria-hidden="true">
    <use :xlink:href="iconName" />
  </svg>
</template>
<script setup>
import { isExternal as external } from '../../utils/validate'
import { defineProps, computed } from 'vue'
const props = defineProps({
  icon: {
    type: String,
    required: true
  },
  // 图标类型
  className: {
    type: String,
    default: ''
  }
})

// 计算属性： 判断当前图标是否为外部图标
const isExternal = computed(() => external(props.icon))
// 外部图标样式
const styleExternalIcon = computed(() => ({
  mask: `url(${props.icon}) no-repeat 50% 50%`,
  '-webkit-mask': `url(${props.icon}) no-repeat 50% 50%`
}))
// 项目内图标
const iconName = computed(() => `#icon-${props.icon}`)
</script>
<style scoped>
.svg-icon {
  width: 1em;
  height: 1em;
  vertical-align: -0.15em;
  fill: currentColor;
  overflow: hidden;
}

.svg-external-icon {
  background-color: currentColor;
  mask-size: cover !important;
  display: inline-block;
}
</style>