vite-plugin-svg-icons插件封装SvgIcon组件详解

通过 vite-plugin-svg-icons 插件封装SvgIcon组件

通过命令安装插件

yarn add vite-plugin-svg-icons -D
# or
npm i vite-plugin-svg-icons -D
# or
pnpm install vite-plugin-svg-icons -D
复制代码

配置 vite.config.ts

//插件引入
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
import path from 'path'

  plugins: [
    vue(),
    Components({
      // UI库
      resolvers: [ArcoResolver()],
    }),
    createSvgIconsPlugin({
      // 指定需要缓存的图标文件夹
      iconDirs: [path.resolve(process.cwd(), "src/assets/icons")],
      // 指定symbolId格式
      symbolId: "icon-[dir]-[name]",

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

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

复制代码

配置 tsconfig.json

如果你使用的 Typescript, 可以在 tsconfig.json 配置文件中添加：

// tsconfig.json
{
  "compilerOptions": {
    "types": ["vite-plugin-svg-icons/client"]
  }
}

配置 main.ts

import 'virtual:svg-icons-register'
复制代码

封装SvgIcon组件 src/components/SvgIcon

复制代码

如果您使用的是tsx页面，可以创建SvgIcon.tsx如下：

import { defineComponent, computed } from "vue";

export default defineComponent({
  name: "SvgIcon",
  props: {
    prefix: {
      type: String,
      default: "icon",
    },
    name: {
      type: String,
      required: true,
    },
    color: {
      type: String,
      default: "#ef4",
    },
  },
  setup(props) {
    const symbolId = computed(() => `#${props.prefix}-${props.name}`);
    return { symbolId };
  },
  render() {
    return (
      
    );
  },
});

同文件夹下创建 index.ts

import { App } from "vue";
import SvgIcon from "./SvgIcon";
import "virtual:svg-icons-register";

const svgIconPlugin = {
  install(app: App): void {
    // 全局挂载
    app.component("svg-icon", SvgIcon);
  },
};

export default svgIconPlugin;

全局注册 main.ts

import { createApp } from "vue";
import App from "./App.vue";
// 路由 router 4.0
import router from "./router/router";
// 状态管理器  Pinia
import { createPinia } from "pinia";
const pinia = createPinia();
// UI库 ardo.design
import ArcoVue from "@arco-design/web-vue";
import "@arco-design/web-vue/dist/arco.css";

// svg封装插件
import svgIcon from "@/components/svgIcon"; +++
  
createApp(App)
  .use(router)
  .use(pinia)
  .use(svgIcon)              
  .use(ArcoVue, {
    componentPrefix: "arco",
  })
  .mount("#app");

复制代码

组件使用 index.vue

// 只需name绑定成icons目录下的svg文件名即可

解决报错

我在使用vite-plugin-svg-icons库的时候启动项目报错：

yarn add fast-glob -D

参考了官网和一些博客，大部分缺斤少两，没有我这篇全面，特此记录一下。

vite-plugin-svg-icons github官网

unplugin 推荐