vite-plugin-svg-icons的用法
时间: 2025-04-24 12:09:51 浏览: 21
### vite-plugin-svg-icons 插件使用教程
#### 安装依赖
为了使用 `vite-plugin-svg-icons`,需要先安装该插件以及一些必要的依赖项。可以通过 npm 或 yarn 来完成这一步骤。
```bash
npm install vite-plugin-svg-icons --save-dev
```
或者
```bash
yarn add vite-plugin-svg-icons --dev
```
#### 配置 Vite
接下来,在项目的根目录下找到或创建 `vite.config.js` 文件,并引入并配置此插件:
```javascript
// vite.config.js
import { defineConfig } from 'vite'
import svgIcons from 'vite-plugin-svg-icons'
export default defineConfig({
plugins: [
svgIcons({
iconDirs: ['./src/assets/icons'], // 设置图标文件夹路径
svgoOptions: {}, // 可选参数 SVGO options, 默认 {}
symbolId: '[dir]-[name]' // 符号 ID 的模板字符串,默认为 `[dir]-[name]`
})
]
})
```
上述代码片段展示了如何通过指定选项来自定义插件行为[^2]。
#### 使用 SVG 图标
一旦完成了以上设置,就可以轻松地在 HTML/SVG 中引用这些图标了。只需利用 `<use>` 标签加上相应的 href 属性即可加载所需图标资源。
```html
<svg>
<use xlink:href="#icon-name"></use> <!-- 替换 #icon-name 为你想要使用的具体图标的ID -->
</svg>
```
此外还可以借助于 React 组件的形式来调用这些图标,如下所示:
```jsx
import React from 'react';
function Icon({ id }) {
return (
<svg className="icon">
<use xlinkHref={`#${id}`} />
</svg>
);
}
export default Icon;
```
这样便可以在 JSX 中像常规组件一样传递 props 来动态改变所显示的具体图标[id]。
#### 进阶配置
对于更复杂的场景,比如希望自动生成 TypeScript 类型声明文件,则可以进一步扩展插件配置:
```javascript
plugins:[
svgIcons({
...
typesDir: './types', // 输出 .d.ts 文件的位置 (可选)
}),
],
```
这样做之后会自动基于扫描到的图标生成对应的接口定义,方便开发者编写类型安全的应用程序。
阅读全文
相关推荐


















