svg圖片在項目中使用的非常廣泛,下面本篇文章帶大家介紹一下如何在vue3 + vite 中使用svg圖標,希望對大家有所幫助!
vite-plugin-svg-icons
預加載 在項目運行時就生成所有圖標,只需操作一次 dom
高性能 內置緩存,僅當文件被修改時才會重新生成
安裝
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.config.ts 中的配置插件
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons' import path from 'path' export default () => { return { plugins: [ createSvgIconsPlugin({ // 指定需要緩存的圖標文件夾 iconDirs: [path.resolve(process.cwd(), 'src/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__', }), ], } }
在 src/main.js 內引入注冊腳本
import 'virtual:svg-icons-register'
如何在組件中使用
創建SvgIcon組件
/src/components/SvgIcon/index.vue
<template> <svg aria-hidden="true" class="svg-icon" :width="props.size" :height="props.size"> <use :xlink:href="symbolId" :fill="props.color" /> </svg> </template> <script setup> import { computed } from 'vue' const props = defineProps({ prefix: { type: String, default: 'icon' }, name: { type: String, required: true }, color: { type: String, default: '#333' }, size: { type: String, default: '1em' } }) const symbolId = computed(() => `#${props.prefix}-${props.name}`) </script>
icons目錄結構
# src/icons - icon1.svg - icon2.svg - icon3.svg - dir/icon1.svg
全局注冊組件
# src/main.js import { createApp } from 'vue' import App from './App.vue' import router from './router' import ElementPlus from 'element-plus' import 'element-plus/dist/index.css' import svgIcon from "@/components/SvgIcon/index.vue"; import 'virtual:svg-icons-register' createApp(App) .use(ElementPlus) .use(router) .component('svg-icon', svgIcon) .mount('#app')
頁面使用
<template> <svg-icon v-if="props.icon" :name="props.icon" /> <span v-if="props.title" slot='title'>{{ props.title }}</span> </template> <script setup> const props = defineProps({ icon: { type: String, default: '' }, title: { type: String, default: '' } }) </script>
獲取所有 SymbolId
import ids from 'virtual:svg-icons-names' // => ['icon-icon1','icon-icon2','icon-icon3']