Vite中怎么配置plugins引入vite-plugin-svg-icons实现SVG图标的雪碧图自动合并

舞夢輝影

舞夢輝影

2026-07-21

965人浏览

原创

在 vite 项目中使用 vite-plugin-svg-icons 实现 svg 雪碧图,需安装插件、配置 icondirs 绝对路径和 symbolid 命名规则,入口文件引入 'virtual:svg-icons-register',并封装 svgicon 组件按需调用。

vite中怎么配置plugins引入vite-plugin-svg-icons实现svg图标的雪碧图自动合并

在 Vite 项目中用 vite-plugin-svg-icons 实现 SVG 雪碧图,核心是让插件自动扫描图标目录、生成统一的 symbol 雪碧图,并支持组件化调用。配置不复杂,但路径、ID 格式和注入时机这几个点容易出错。

安装插件并声明依赖

插件属于开发时工具,只需作为 devDependency 安装:

  • npm install -D vite-plugin-svg-icons
  • yarn add -D vite-plugin-svg-icons
  • 注意:不需要额外安装 SVGO 或 @types/node(除非 TypeScript 报 path 类型错误,此时再补 yarn add -D @types/node

vite.config.ts/js 中启用插件

关键在于指定图标存放路径和 symbol ID 的命名规则,确保与后续引用方式一致:

svg中文手册
svg中文手册

svg中文手册下载

下载
  • iconDirs 必须是绝对路径,推荐用 path.resolve(process.cwd(), 'src/assets/icons')
  • symbolId 决定你在 <use href="#xxx"></use> 中填什么,常见写法有:
    'icon-[name]' → 引用时写 #icon-home
    'icon-[dir]-[name]' → 适合多级目录,如 #icon-nav-menu
  • 可选配 svgoOptions 去除默认 fill,方便 CSS 控制颜色,例如:
    { name: 'removeAttrs', params: { attrs: 'fill' } }

入口文件注册雪碧图注入逻辑

插件会在构建时自动生成一个虚拟模块,必须在主入口(如 main.tsmain.js)顶部显式引入:

  • import 'virtual:svg-icons-register'
  • 这行代码不能漏,也不能放在 setup 或异步逻辑里 —— 它负责把雪碧图 <svg style="display:none">...</svg> 插入 DOM
  • 开发时实时生效;生产环境会打包进 assets,由注册逻辑自动挂载

封装 SvgIcon 组件实现按需调用

避免每次手写 <svg><use href="#..."></use></svg>,建议封装一个通用组件:

  • 组件接收 name(对应 SVG 文件名)、colorsize 等 props
  • href 拼接要严格匹配 symbolId 规则,比如 symbolId: 'icon-[name]',则 :xlink:href="'#icon-' + name"
  • CSS 中设 fill: currentColor,这样传 color 就能直接控制图标颜色
  • 全局注册或局部引入均可,推荐在 main.ts 中全局注册一次

配完就能直接用 <svgicon name="home" size="20px" color="#1890ff"></svgicon>,所有 SVG 自动合并、按需渲染、样式可控。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2389

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

718

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

2184

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

638

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1167

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

2108

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

2370

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

1499

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

500

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二期_大前端线上班
第二期_大前端线上班

共345课时 | 74.5万人学习

Webpack4.x---十天技能课堂
Webpack4.x---十天技能课堂

共20课时 | 1.9万人学习

两小时学会 Webpack
两小时学会 Webpack

共14课时 | 2万人学习