unplugin-svg-component

v0.10.3

generate a vue/react component through svg files, supporting svg file HMR and typescript intelligence prompt. For more information about how to use this package see README

Latest version published 6 months ago

License: MIT

NPM

GitHub

Package Health Score

56 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.10.3	\|	05/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.9.1	\|	05/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.8.0	\|	01/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.7.6	\|	09/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.6.0	\|	04/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,266)

GitHub Stars: 56
Forks: 5
Contributors: 3

Direct Usage Popularity

The npm package unplugin-svg-component receives a total of 1,266 downloads a week. As such, we scored unplugin-svg-component popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package unplugin-svg-component, we found that it has been starred 56 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 3
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like unplugin-svg-component is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 4
Open PR: 0
Last Release: 6 months ago
Last Commit: 4 months ago

Further analysis of the maintenance status of unplugin-svg-component based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that unplugin-svg-component demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 8 Direct
Versions: 30
Install Size: 135 kB
Dist-tags: 1
# of Files: 26
Maintainers: 1
TS Typings: No

unplugin-svg-component has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

unplugin-svg-component

English | 中文

> unplugin-svg-component 启发于vite-plugin-svg-icons,它将本地的svg文件生成为一个 vue/react 组件, 通过该组件结合svg文件的名称使用svg图标。

智能提示效果

Vue

React

功能

智能提示: 使用组件时, 配合 Typescript 会提示出 svg 文件名称
热更新: svg 文件的增删改操作, 都会实时显示于页面上, 无需刷新浏览器
Vue & React 支持: 自动检测项目类型
Tree-shaking: 从v0.5.0版本开始, 生产环境只会打包你用到的 svg 图标
SSR: 通过开启 option.domInsertionStrategy = 'replaceHtml' 这个选项(默认开启)支持SSR.

安装

yarn add unplugin-svg-component -D
# or
npm i unplugin-svg-component -D
# or
pnpm install unplugin-svg-component -D

使用

Vite config

// vite.config.ts
import UnpluginSvgComponent from 'unplugin-svg-component/vite'

export default defineConfig({
  plugins: [
    UnpluginSvgComponent({ /* options */ })
  ],
})

Vue-cli config

// vue.config.js
const { defineConfig } = require('@vue/cli-service')
const UnpluginSvgComponent = require('unplugin-svg-component/webpack').default

module.exports = defineConfig({
  configureWebpack: {
    plugins: [
      UnpluginSvgComponent({ /* options */ })
    ]
  }
})

Webpack config

// webpack.config.js
const UnpluginSvgComponent = require('unplugin-svg-component/webpack').default

module.exports = {
  /* ... */
  plugins: [
    UnpluginSvgComponent({ /* options */ }),
  ],
}

Rollup config

// rollup.config.js
import UnpluginSvgComponent from 'unplugin-svg-component/rollup'

export default {
  plugins: [
    UnpluginSvgComponent({ /* options */ }),
  ],
}

Esbuild config

// esbuild.config.js
import { build } from 'esbuild'
import UnpluginSvgComponent from 'unplugin-svg-component/esbuild'

build({
  /* ... */
  plugins: [
    UnpluginSvgComponent({
      /* options */
    }),
  ],
})

Vue

// main.ts
import SvgIcon from '~virtual/svg-component'

app.component(SvgIcon.name, SvgIcon)

React

// App.tsx
import SvgIcon from '~virtual/svg-component'

function App() {
  return (
    <div>
      
    </div>
  )
}

获取`svgNames` / 类型 `SvgName`

// all svg icon name
import { svgNames } from '~virtual/svg-component'

// type SvgName = "icon-icon-addUser" | "icon-icon-barCode"
import type { SvgName } from '~virtual/svg-component'

插件配置

属性	类型	默认值	描述
iconDir	`string \| string[]`	-	图标文件夹位置
projectType	`vue \| react \| auto`	auto	项目类型, 默认会自动检测
dts	`boolean`	-	是否生成d.ts文件
dtsDir	`string`	-	d.ts文件位置
prefix	`string`	-	给每个svg name加上前缀,使用时记得加上这个前缀
componentName	`string`	SvgIcon	生成的组件名称
componentStyle	`string`	width: 1em; height: 1em; fill:currentColor;	组件的行内样式
preserveColor	`RegExp`	-	通常, 插件会把svg标签内的fill, stroke属性替换成currentColor, 此属性会对每个svg路径进行正则匹配, 匹配成功的svg则不会替换currentColor, 而是保留原有的颜色.
symbolIdFormatter	`(svgName:string, prefix: string)=>string`	code	可以通过这个参数来设置symbolId的格式
optimizeOptions	`SvgoOptions`	-	svgo 的优化参数
svgSpriteDomId	`string`	svg_sprite__dom	自定义生成的svg元素的id
vueVersion	`2 \| 3 \| auto`	auto	Vue 版本, 默认会自动检测
treeShaking	`boolean`	true	是否开启tree-shaking
scanGlob	`string[]`	code	用于 tree-shaking 的模式匹配路径
scanStrategy	`text \| component \| (code: string[], options: Options)=>string[]`	component	用于 tree-shaking 的模式匹配策略, 未匹配成功则不会打包到最终的产物中去, `text`选项表示按图标名称匹配, 所以你应该保证你图标名称的唯一性(可以考虑用`symbolIdFormatter`选项定制)，以此避免错误的tree-shaking, 而默认值`component`表示的是按组件这一整体进行匹配, 此外你也可以通过传递函数的方式来实现 tree-shaking 策略, 函数的返回值表示用到的 svg 图标合集。
domInsertionStrategy	`replaceHtml \| dynamic`	`replaceHtml`	控制注入SVG元素的方法,`replaceHtml（默认）`：在服务端通过替换HTML字符串来注入SVG元素; `dynamic`：在浏览器端,通过JavaScript动态地注入SVG元素。警告：如果您处于服务器端渲染（ssr）模式，您应该使用`replaceHtml`策略。

Typescript 支持

// tsconfig.json
{
  "include": ["svg-component.d.ts", "svg-component-global.d.ts"]
}

最佳实践

可以根据需求参考examples, 注意 examples 中的配置都是默认配置.

Contributing

Fork ()
新建一个分支 (git checkout -b feature/fooBar)
提交你的代码 (git commit -am 'Add some fooBar')
提交到你的远程分支 (git push origin feature/fooBar)
提交PR

License

unplugin-svg-component dependencies

cors etag fast-glob local-pkg picocolors svg-sprite svgo unplugin

unplugin-svg-component development dependencies

@antfu/eslint-config @types/cors @types/debug @types/etag @types/node @types/svg-sprite @vue/compiler-sfc bumpp chalk debug eslint esno tsup typescript vitest vue

FAQs

What is unplugin-svg-component?

generate a vue/react component through svg files, supporting svg file HMR and typescript intelligence prompt. Visit Snyk Advisor to see a full health score report for unplugin-svg-component, including popularity, security, maintenance & community analysis.

Is unplugin-svg-component popular?

The npm package unplugin-svg-component receives a total of 1,266 weekly downloads. As such, unplugin-svg-component popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is unplugin-svg-component well maintained?

We found indications that unplugin-svg-component maintenance is sustainable demonstrating some project activity. We saw a total of 3 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is unplugin-svg-component safe to use?

While scanning the latest version of unplugin-svg-component, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 13 November-2024, at 23:57 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,266)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

unplugin-svg-component

智能提示效果

Vue

React

功能

安装

使用

Vue

React

获取svgNames / 类型 SvgName

插件配置

Typescript 支持

最佳实践

Contributing

License

unplugin-svg-component dependencies

unplugin-svg-component development dependencies

FAQs

What is unplugin-svg-component?

Is unplugin-svg-component popular?

Is unplugin-svg-component well maintained?

Is unplugin-svg-component safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

获取`svgNames` / 类型 `SvgName`