vue3中使用svg并封装成组件

打包svg地图

  • 安装插件

    sh 复制代码
    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

    ts 复制代码
    import { VantResolver } from 'unplugin-vue-components/resolvers'
    +import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
    +import path from 'path'
    
    // https://vitejs.dev/config/
    export default defineConfig({
      plugins: [
        vue(),
        Components({
          dts: false,
          resolvers: [VantResolver({ importStyle: false })]
        }),
    +    createSvgIconsPlugin({
    +      // 指定图标文件夹,绝对路径(NODE代码)
    +      iconDirs: [path.resolve(process.cwd(), 'src/icons')]
    +    })
      ],
  • 导入到main

    ts 复制代码
    +import 'virtual:svg-icons-register'
  • 使用svg精灵地图

    html 复制代码
        <svg aria-hidden="true">
          <!-- #icon-文件夹名称-图片名称 -->
          <use href="#icon-login-eye-off" />
        </svg>

小结:

  • icons文件打包的产物?
    • 会生成一个 svg 结构(js创建的)包含所有图标,理解为 精灵图
  • 怎么使用svg图标?
    • 通过 svg 标签 #icon-文件夹名称-图片名称 指定图片,理解 精灵图定位坐标

【坑】vite-plugin-svg-icons报错:Cannot find package 'fast-glob'


自行安装一下fast-glob依赖解决该问题

sh 复制代码
yarn add fast-glob -D

图标组件-封装svg组件

组件 components/CpIcon.vue

html 复制代码
<script setup lang="ts">
// 提供name属性即可
defineProps<{
  name: string
}>()
</script>

<template>
  <svg aria-hidden="true" class="cp-icon">
    <use :href="`#icon-${name}`" />
  </svg>
</template>

<style lang="scss" scoped>
.cp-icon {
  // 和字体一样大
  width: 1em;
  height: 1em;
}
</style>

如果使用了 unplugin-vue-components 默认 src/compoenents 自动导入注册;

给组件添加类型,让写属性和事件可以有提示

类型 types/components.d.ts

ts 复制代码
// 1. 导入组件实例
import CpIcon from '@/components/CpIcon.vue'
// 2. 声明 vue 类型模块
declare module 'vue' {
// 3. 给 vue  添加全局组件类型,interface 和之前的合并
  interface GlobalComponents {
  // 4. 定义具体组件类型,typeof 获取到组件实例类型
  // typeof 作用是得到对应的TS类型
    CpIcon: typeof CpIcon
  }
}

使用:

html 复制代码
<template>
  <cp-icon name="login-eye-off"></cp-icon>
</template>
相关推荐
Wiktok8 小时前
【pure-admin】pureadmin的登录对接后端
vue3·pureadmin
Wiktok16 小时前
【Wit】pure-admin后台管理系统前端与FastAPI后端联调通信实例
前端·vue3·pureadmin
Wiktok2 天前
前后端开发Mock作用说明,mock.ts
前端·mock·vue3
小菜花292 天前
利用H5实现svg图片中各部分监听事件
前端·javascript·svg·object标签
知识分享小能手2 天前
React学习教程,从入门到精通,React AJAX 语法知识点与案例详解(18)
前端·javascript·vue.js·学习·react.js·ajax·vue3
Wiktok3 天前
pureadmin的动态路由和静态路由
前端·vue3·pureadmin
Jinuss3 天前
Vue3源码reactivity响应式篇之watch实现
前端·vue3
知识分享小能手3 天前
React学习教程,从入门到精通,React 组件生命周期详解(适用于 React 16.3+,推荐函数组件 + Hooks)(17)
前端·javascript·vue.js·学习·react.js·前端框架·vue3
哆啦A梦15884 天前
uniapp分包实现
前端·vue.js·uni-app·vue3
叫我阿柒啊4 天前
从Java全栈到前端框架的实战之路
java·数据库·微服务·typescript·前端框架·vue3·springboot