@gkatsanos/vite-svg-loader

中文文档
1.3.1发布于 2024/07/16MITTypeScriptCommonJS近 30 天下载 2916

管理 SVG 文件的 Vite 加载器

中文使用文档
文档目录11 节
  1. 安装
  2. 设置
  3. 导入参数
  4. 網址
  5. 原始内容
  6. 构成部分
  7. 默认导入配置
  8. SVGO 配置
  9. 禁用 SVGO
  10. 为单一文件跳过 SVGO
  11. 使用类型脚本

这是叉子 https://github.com/jpkleemans/vite-svg-loader (中文(简体) ) 与它取代的唯一区别 component 与 inline 使其向后兼容使用 webpack svg 加载器的组件.

Vite SVG 装入器

将SVG文件装入Vue组件的Vite插件,使用SVGO进行优化.

Version Downloads Tests License

<template>
  <MyIcon />
</template>

<script setup>
import MyIcon from './my-icon.svg'
</script>

安装

npm install vite-svg-loader --save-dev

设置

vite.config.js

import svgLoader from 'vite-svg-loader'

export default defineConfig({
  plugins: [vue(), svgLoader()]
})

导入参数

網址

SVG 可以使用 ?url 后缀 :

import iconUrl from './my-icon.svg?url'
// '/assets/my-icon.2d8efhg.svg'

原始内容

SVG 可以使用 ?raw 后缀 :

import iconRaw from './my-icon.svg?raw'
// '<?xml version="1.0"?>...'

构成部分

SVG 可以使用 ?inline 后缀 :

import IconComponent from './my-icon.svg?inline'
// <IconComponent />

默认导入配置

当未提供明确的参数时, SVG 默认会被导入为 Vue 组件 . 使用 defaultImport 配置设置, 这样,没有参数的 SVG 会被导入为 URL(或原始字符串) .

vite.config.js

svgLoader({
  defaultImport: 'url' // or 'raw'
})

SVGO 配置

vite.config.js

svgLoader({
  svgoConfig: {
    multipass: true
  }
})

禁用 SVGO

vite.config.js

svgLoader({
  svgo: false
})

为单一文件跳过 SVGO

SVGO 可以通过添加 ?skipsvgo 后缀 :

import IconWithoutOptimizer from './my-icon.svg?skipsvgo'
// <IconWithoutOptimizer />

使用类型脚本

如果您在 Typescript 项目中使用了装入器, 您需要导入您的 svg 文件 ?inline 段落 : import MyIcon from './my-icon.svg?inline'。 。 。 .

您还需要参考类型定义 :

/// <reference types="vite-svg-loader" />

版本与发布记录

@gkatsanos/vite-svg-loader 共发布 7 个版本,首次发布于 2023/05/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.3.1latest2024/07/162 年前
1.3.02023/05/233 年前
1.2.02023/05/053 年前
1.1.22023/05/043 年前
1.1.12023/05/043 年前
1.1.02023/05/043 年前

关于 @gkatsanos/vite-svg-loader 的常见问题

@gkatsanos/vite-svg-loader 是什么?

管理 SVG 文件的 Vite 加载器

如何安装 @gkatsanos/vite-svg-loader?

在项目目录运行 npm install @gkatsanos/vite-svg-loader,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vue(>=3.2.13)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gkatsanos/vite-svg-loader 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gkatsanos/vite-svg-loader 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gkatsanos/vite-svg-loader 可以商用吗?

@gkatsanos/vite-svg-loader 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gkatsanos/vite-svg-loader 的下载量有多少?

根据 npm 官方下载统计,@gkatsanos/vite-svg-loader 在 2026/10/17 – 2026/11/15 这 30 天内被下载 2,916 次,日均约 97 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gkatsanos/vite-svg-loader 还在维护吗?

最新版本 1.3.1 发布于 2024/07/16(2 年前);至今共发布 7 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/05/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。