推荐一款Vite中加载svg的小工具

news2024/11/18 0:47:03

最近开发中使用到一个好玩的Vite三方小插件vite-plugin-svg-icons很实用，可以辅助我们开发过程中快速加载svg小图标。其原理是在Vite编译器的时候通过一次性的DOM操作将SVG插入DOM结构中，然后通过使用内联SVG进行加载访问，极大的方便了我们的小图标引用模式。若只是少量的svg图片加载建议食用，若是svg图片数量过多并不建议采用（过多的svg文件插入也会导致我们的html文件过大）。

安装

通过上述了解后，接下我们来配置使用vite-plugin-svg-icons插件，该插件需要Vite支持。

$ npm i  vite-plugin-svg-icons -D // 或
$ yarn add vite-plugin-svg-icons -D // 或
$ pnpm i vite-plugin-svg-icons -D

由于其主要是在编译打包期生效，所以放在devDependencies中即可。

配置

安装完成后，需要在vite.config.ts中引入该插件，并配置对应svg地址：

// vite.config.ts
import * as path from 'node:path'
import type { ConfigEnv, UserConfig } from 'vite'
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
import vue from '@vitejs/plugin-vue'
import vueJsx from '@vitejs/plugin-vue-jsx'
import Unocss from 'unocss/vite'

export default ({ mode }: ConfigEnv): UserConfig => {

  return {
    plugins: [
      vue(),
      vueJsx(),
      Unocss(),
      createSvgIconsPlugin({
        // 指定需要缓存的图标文件夹
        iconDirs: [path.resolve(process.cwd(), 'src/bpmn-icons')],
        // 指定symbolId格式
        symbolId: '[name]',
        customDomId: '__svg__icons__dom__',
      }),
    ],
}

在vite.config.ts配置完成后还需要再程序的入口处引入virtual:svg-icons-register 库用于注册插入SVG的DOM树：

// main.ts
import 'virtual:svg-icons-register'
.......

封装组件

完成上述的配置操作后，我们就可以封装一个内联SVG方便随时使用了，我这里使用的VUE3作为开发框架，你也可以使用React、nextjs等进行封装，原理相同。

// svg-icon.vue
<script lang="ts">
import { defineComponent } from 'vue'

export default defineComponent({
  name: 'BpmnIcon',
  inheritAttrs: false,
  props: {
    name: {
      type: String,
      default: 'bpmn-icon-process',
    },
    color: {
      type: String,
      default: '#1d1d1f',
    },
  },
})
</script>

<template>
  <svg class="bpmn-icon h-[40px] w-[40px]" aria-hidden="true">
    <use :xlink:href="`#${name}`" :fill="color" />
  </svg>
</template>

上述有用到unocss方式进行样式渲染，配置使用请参考前文：【开发一个Vue3组件】 | 如何创建一个本地库项目

使用

通过上述封装操作后，我们就可以和其他组件一样来使用这个组件了，这里使用的是我一个已有项目的代码不额外写一个测试页面了，因为使用的确特别的简单，示例代码如下：

// test.vue

<div class="panel-header flex items-center gap-5 bg-light-300 px-3 py-5">
     <SvgIcon name={bpmnIconName.value}></SvgIcon>
     <div class='inline-block'>
       <p class="mb-0 mb-1 text-[1.3em] font-bold text-black">{elementType.value}</p>
       <p class="mb-0 pb-0 text-[1em] text-black">{bpmnName.value}</p>
      </div>
</div>

展示效果如下：