vue3+vite项目中显示SVG图片的实现

 更新时间:2024年02月21日 14:50:55   作者:码农键盘上的梦  
vite-plugin-svg-icons是一个Vite插件,其作用是将SVG图标文件转换为Vue组件,本文主要介绍了vue3+vite项目中显示SVG图片的实现示例,具有一定的参考价值,感兴趣的可以了解一下

vite-plugin-svg-icons是一个Vite插件,其作用是将SVG图标文件转换为Vue组件,以便在Vue项目中使用。

使用vite-plugin-svg-icons插件,可以将SVG图标文件导入到项目中,并将其转换为可复用的Vue组件。这样,就可以像使用普通Vue组件一样使用这些SVG图标,包括在模板中直接使用、传递属性、绑定事件等。

该插件还提供了一些额外的功能,如自动按需引入图标、支持图标的自定义命名、支持指定图标大小等。

总之,vite-plugin-svg-icons插件的作用是简化在Vue项目中使用SVG图标的过程,提供了更加灵活和方便的方式来管理和使用这些图标。

vite-plugin-svg-icons 安装

node version: >=12.0.0

vite version: >=2.0.0

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

配置使用vite-plugin-svg-icons

  • 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.ts 内引入注册脚本
import 'virtual:svg-icons-register'

到这里 svg 已经引入可以使用

如何在Vue 组件使用

/src/components/SvgIcon.vue

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

<script>
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: '#333',
    },
  },
  setup(props) {
    const symbolId = computed(() => `#${props.prefix}-${props.name}`)
    return { symbolId }
  },
})
</script>

icons 目录结构

# src/icons

- icon1.svg
- icon2.svg
- icon3.svg
- dir/icon1.svg

/src/App.vue

<template>
  <div>
    <SvgIcon name="icon1"></SvgIcon>
    <SvgIcon name="icon2"></SvgIcon>
    <SvgIcon name="icon3"></SvgIcon>
    <SvgIcon name="dir-icon1"></SvgIcon>
  </div>
</template>

<script>
import { defineComponent, computed } from 'vue'

import SvgIcon from './components/SvgIcon.vue'
export default defineComponent({
  name: 'App',
  components: { SvgIcon },
})
</script>

优点

  • 可扩展性:vite-plugin-svg-icons 提供了灵活的配置选项,允许开发者自定义图标的加载和使用方式。

  • 轻量级:vite-plugin-svg-icons 是一个轻量级的插件,没有额外的依赖,可以快速集成到现有的项目中。

  • 性能优化:vite-plugin-svg-icons 可以将 SVG 图标转换为内联的 Vue 组件,减少 HTTP 请求,提高页面加载速度。

  • 简化开发流程:使用 vite-plugin-svg-icons,开发者可以直接在代码中引用 SVG 图标,无需手动处理 SVG 文件。

  • 兼容性:vite-plugin-svg-icons 支持多种类型的 SVG 图标,包括普通的 SVG 文件、Symbol 图标和图标字体等。

到此这篇关于vue3+vite项目中显示SVG图片的实现的文章就介绍到这了,更多相关vue3 显示SVG图片内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家! 

相关文章

  • 基于vue-cli vue-router搭建底部导航栏移动前端项目

    基于vue-cli vue-router搭建底部导航栏移动前端项目

    这篇文章主要介绍了基于vue-cli vue-router搭建底部导航栏移动前端项目,项目中主要用了Flex布局,以及viewport相关知识,已达到适应各终端屏幕的目的。需要的朋友可以参考下
    2018-02-02
  • vue 解决form表单提交但不跳转页面的问题

    vue 解决form表单提交但不跳转页面的问题

    今天小编就为大家分享一篇vue 解决form表单提交但不跳转页面的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-10-10
  • Vue使用PDF.js实现浏览pdf文件功能

    Vue使用PDF.js实现浏览pdf文件功能

    这篇文章主要为大家详细介绍了Vue如何使用PDF.js实现浏览pdf文件功能,文中的实现步骤讲解详细,具有一定的借鉴价值,需要的可以参考一下
    2023-04-04
  • vite+vue3项目启动报错Unexpected “%“问题及解决

    vite+vue3项目启动报错Unexpected “%“问题及解决

    这篇文章主要介绍了vite+vue3项目启动报错Unexpected “%“问题及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-03-03
  • vue中v-model、v-bind和v-on三大指令的区别详解

    vue中v-model、v-bind和v-on三大指令的区别详解

    v-model和v-bind都是数据绑定的方式,下面这篇文章主要给大家介绍了关于vue中v-model、v-bind和v-on三大指令的区别,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-11-11
  • Vue Element UI自定义描述列表组件

    Vue Element UI自定义描述列表组件

    这篇文章主要为大家详细介绍了Vue Element UI自定义描述列表组件,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-05-05
  • Element实现登录+注册的示例代码

    Element实现登录+注册的示例代码

    登录注册是最常用的网站功能,本文主要介绍了Element实现登录+注册的示例代码,具有一定的参考价值,感兴趣的可以了解一下
    2023-09-09
  • Vue 技巧之控制父类的 slot

    Vue 技巧之控制父类的 slot

    插槽(Slot)是Vue提出来的一个概念,正如名字一样,插槽用于决定将所携带的内容,插入到指定的某个位置,从而使模板分块,具有模块化的特质和更大的重用性。
    2020-02-02
  • 解决vue表单为空也能提交的问题

    解决vue表单为空也能提交的问题

    这篇文章主要介绍了解决vue表单为空也能提交的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • Vue2和Vue3中常用组件通信用法分享

    Vue2和Vue3中常用组件通信用法分享

    这篇文章主要为大家整理了Vue3的8种和Vue2的12种组件通信的使用方法,文中的示例代码讲解详细,对我们学习Vue有一定的帮助,值得收藏
    2023-04-04

最新评论