Vite创建的Vue3项目中封装SvgIcon组件

什么是Svg?

SVG(Scalable Vector Graphics)是一种基于可扩展标记语言(XML)的开放标准矢量图形格式。它用于描述二维矢量图形,并且可以嵌入到HTML和XML文档中。SVG文件可以通过文本格式的描述性语言来描述图像内容,因此它是一种和图像分辨率无关的矢量图形格式。

SVG图形格式具有许多优点。首先,图像文件可读,易于修改和编辑。其次,它与现有技术可以互动融合,例如SVG技术本身的动态部分是基于SMIL标准。此外,SVG文件非常轻巧,这意味着它们可以很快地加载,即使是在网络上。最后,SVG可以支持多种效果,如渐变、阴影和反射等,这些效果不可能用位图完成。

Svg格式图片和其他格式图片有什么区别呢?

SVG图片和常见的位图图片(如JPEG和PNG)有很大的区别。位图图片是由许多像素点组成的,而矢量图形是由数学公式定义的。这使得矢量图形可以在不损失质量的情况下进行任意缩放,而位图图片在放大时则会变得模糊。

为什么我们要将其封装成一个单独的组件?

  1. 可缩放性:SvgIcon组件可以利用SVG的特性,使得图标可以在不失真的情况下进行缩放。这对于需要根据用户需求动态调整大小或者需要在不同分辨率下都能清晰显示的图标来说非常有用。
  2. 可编辑性:由于SVG图标是由XML代码定义的,因此可以方便地进行修改和编辑。这在需要定制图标或者图标需要经常变动的情况下非常方便。
  3. 支持复杂交互:SVG图标可以支持鼠标事件(如点击、悬停等),这使得可以在图标上实现一些复杂的交互功能。

SvgIcon组件在Vue中用于专门展示SVG图标,可以充分利用SVG的优点,使得图标的显示和交互都能得到更好的支持。

封装过程

我们借助插件实现SvgIcon组件的封装,具体步骤如下:

  1. 安装插件:yarn add -D vite-plugin-svg-icons
  2. 配置vite.config.js(vite.config.ts)配置文件,导入,并将其插件配置到plugins数组当中
js 复制代码
// SvgIcon组件封装插件引入
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'

export default defineConfig({
  // 其他配置...
  plugins: [
      createSvgIconsPlugin({
          // 指定需要缓存的图标文件夹
          iconDirs: [path.resolve(process.cwd(), 'src/assets/svg')],
          // 指定symbolId格式
          symbolId: 'icon-[dir]-[name]'
      })
  ]
})
  1. 新建SvgIcon组件
vue 复制代码
<template>
  <!--svg外层容器,需要配置子元素use使用-->
  <svg :style="{width, height}">
    <!--xlink:href引用的svg图标,#icon-图标名-->
    <use :xlink:href="symbolId" :fill="fill" />
  </svg>
</template>

<script setup>
import {computed} from "vue"
const props = defineProps({
  prefix: {
    type: String,
    default: 'icon'
  },
  name: {
    type: String,
    required: true
  },
  width: {
    type: String,
    default: "16px"
  },
  height: {
    type: String,
    default: "16px"
  },
  fill: {
    type: String,
    default: '#333'
  }
})
// svg icon引入的格式
const symbolId = computed(() => {
  return `#${props.prefix}-${props.name}`
})
</script>
  1. 配置main.js(main.ts),在其中新增一行注册svg图标注册
js 复制代码
// svg图标注册
import 'virtual:svg-icons-register'
  1. 使用,在使用的组件中导入svgIcon,然后指定其属性name(表示svg图片名称,需要与svg文件名去除后缀一致)
js 复制代码
<template>
  <svg-icon name="sun" fill="red"/>
</template>

<script setup>
import svgIcon from '@/components/svgIcon/index.vue'
</script>

上述name必须指定sun,然后插件会根据dir-name去找到对应目录的svg图片

推荐一个Svg图标库

参考阿里巴巴的开源矢量图组件库iconfont,传送门:www.iconfont.cn/

相关推荐
FRing033 小时前
vue2干货总结11(短信验证、登录功能、统一处理错误(响应拦截器)、将token信息存入vuex、vuex持久化处理)
开发语言·前端·javascript·vue.js·vue2
Java小卷4 小时前
面向 Schema 编程,Vue 3 页面级渲染引擎!强大的第三方 UI 适配与扩展(一)
vue.js·低代码
鹿鹿鹿鹿isNotDefined4 小时前
布局更新后,canvas 重新绘制,出现了只持续一帧的闪烁?!
前端·javascript·vue.js
闲来没事抠鼻屎4 小时前
PDF导出与网页打印控件:两条交付路线怎么选
vue.js
FRing038 小时前
vue2干货总结10(json-server、vant-ui、postcss插件、axios二次封装、图形验证码、toast轻提示)
开发语言·前端·vue.js·ui·json·vue2·postcss
程序员大阳8 小时前
副队长ES6+教程(5)--模板字符串
javascript·vue.js·es6·模板字符串
程序员大阳8 小时前
副队长ES6+教程(4)--拓展运算符
javascript·vue.js·es6·收集·拓展运算符·展开
徐小夕9 小时前
CADViewer-Skill:让 Agent 原生支持 DWG 解析、可视化图统计、图纸导出
前端·vue.js·github
FungLeo1 天前
成为全栈·Vue 管理后台篇·分类树与标签管理:层级数据如何落到管理界面
前端·javascript·vue.js·分类树·naive ui·标签管理·前端数据结构
ruanno_top1 天前
选中一项后,焦点掉回了页面顶部:三个弹层的焦点还原
vue.js