vue3+vite2中使用svg的方法詳解(親測可用)

2022-08-09 18:00:17

前言：
一、安裝vite-plugin-svg-icons
二、在src/components/svgIcon下新建元件index.vue
三、tsconfig.json中新增設定
四、vite.config.ts 中的設定外掛
五、在main.ts全域性註冊元件
六、在頁面中使用
七、檔案目錄結構及其效果展示
八、參考連結地址
總結

技術棧：vue3+vite2

前言：

寫過一版基於vue-cli中使用svg的方法，但是因為webpack提供了require.context()在vite中無法使用，所以基於vite構建的專案則採取另一種方法

一、安裝vite-plugin-svg-icons

此處還需要安裝下fast-glob相關依賴，不然vite執行npm run dev時會報Cannot find module 'fast-glob’的錯誤

npm i fast-glob@3.x -D
npm i vite-plugin-svg-icons@2.x -D

二、在src/components/svgIcon下新建元件index.vue

<template>
  <svg aria-hidden="true" class="svg-icon">
    <use :xlink:href="symbolId" rel="external nofollow"  :fill="color" />
  </svg>
</template>

<script setup lang="ts">
import { computed } from 'vue';

const props = defineProps({
  prefix: {type: String,default: 'icon',},
  iconClass: {type: String,required: true,},
  color: {type: String,default: ''}
})

const symbolId = computed(() => `#${props.prefix}-${props.iconClass}`);
</script>

<style scoped>
.svg-icon {
  width: 1em;
  height: 1em;
  vertical-align: -0.15em;
  overflow: hidden;
  fill: currentColor;
}
</style>

三、tsconfig.json中新增設定

types用來指定需要包含的模組，只有在這裡列出的模組的宣告檔案才會被載入進來。非必要新增，我在兩個demo測試的時候，一個需要一個不需要，若有問題可以嘗試新增

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

四、vite.config.ts 中的設定外掛

import { resolve } from 'path'
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'

export default defineConfig({
  plugins: [
    createSvgIconsPlugin({
      // 指定需要快取的圖示資料夾
      iconDirs: [resolve(process.cwd(), 'src/assets/imgs/svg')],
      // 指定symbolId格式
      symbolId: 'icon-[dir]-[name]',
    })
  ]
})

五、在main.ts全域性註冊元件

import { createApp } from 'vue'
import App from './App.vue'
import router from '@/router'
import { store, key } from '@/store'

const app = createApp(App)

import 'virtual:svg-icons-register' // 引入註冊指令碼
import SvgIcon from '@/components/svgIcon/index.vue' // 引入元件
app.component('svg-icon', SvgIcon)

app.use(router).use(store, key).mount('#app')

六、在頁面中使用

<template>
  <svg-icon icon-class="category"></svg-icon>
  <svg-icon icon-class="accountant" style="width: 10em; height: 10em;border: 1px solid #000000;"></svg-icon>
</template>