npmpackage.info

svg-sprite-vue-generator

Vue component runtime generator for svg-sprite-loader.

1.0.6

MIT

JavaScript

291.36 kB

1,464 1.7

Installations

npm install svg-sprite-vue-generator

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.13.0

NPM Version

6.13.1 Score

48.4

Supply Chain

Quality

64.6

Maintenance

Vulnerability

96.4

License

Pull Requests

Open

25

Total

31

Closed

6

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 1 Contributors

Languages

JavaScript

HTML

JavaScript (90.51%)

HTML (9.49%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

Akimyou

Download Statistics

Total Downloads

1,464

Last Day

Last Week

Last Month

Last Year

205

GitHub Statistics

MIT License

3 Stars

20 Commits

2 Watchers

26 Branches

1 Contributors

Updated on Apr 15, 2020

Bundle Size

1.02 MB

Minified

291.36 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.0.6

Package Id

svg-sprite-vue-generator@1.0.6

Unpacked Size

388.48 kB

Size

133.32 kB

File Count

NPM Version

6.13.1

Node Version

10.13.0

Total Downloads

Cumulative downloads

Total Downloads

1,464

Last Day

Compared to previous day

Last Week

Compared to previous week

Last Month

-44.4%

Compared to previous month

Last Year

6.2%

205

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

pascal-case svg-sprite-loader

Dev Dependencies

@vue/cli-plugin-babel @vue/cli-service babel-loader core-js svgo-loader vue vue-template-compiler

svg-sprite-vue-generator

Vue component runtime generator for svg-sprite-loader.

Install

1npm install svg-sprite-vue-generator -D

Usage

Inline mode

All svg icon will be inline to part of the component.

Inline mode is default mode from svg-sprite-loader. It called spriteModule.

https://github.com/JetBrains/svg-sprite-loader#spritemodule-autoconfigured

1import FacebookSprite from './assets/facebook.sprite.svg'
2import TwitterSprite from './assets/twitter.sprite.svg'
3import wikipedia from './assets/wikipedia.svg'
4
5// FacebookSprite will be a valid vue component, use it as an vue component
6
7console.log(FacebookSprite)
8// render as: <svg><use xlink:href="#facebook.sprite"></use></svg>
9
10console.log(TwitterSprite)
11// render as: <svg><use xlink:href="#twitter.sprite"></use></svg>
12
13// wikipedia still be an normal asset url, use it as normal image asset url in html img tag or css background-image
14
15console.log(wikipedia)
16// log as: /static/img/wikipedia.77b80eb8.svg

Config

May be need to install related loaders, such as:

babel-loader
svgo-loader

1// vue.config.js
2module.exports = {
3  chainWebpack: config => {
4    // default file-loader
5    config.module.rule('svg')
6      .exclude.add(/\.sprite\.(svg)(\?.*)?$/).end()
7
8    // add svg-sprite-loader
9    config.module.rule('svg-sprite')
10      .test(/\.sprite\.(svg)(\?.*)?$/)
11      .use('babel-loader').loader('babel-loader').end()
12      .use('svg-sprite-loader').loader('svg-sprite-loader').tap(() => {
13        return {
14          runtimeGenerator: require.resolve('svg-sprite-vue-generator'),
15        }
16      }).end()
17      .use('svgo-loader').loader('svgo-loader')
18  }
19}

Extract mode

All svg file will be group to an independent svg file.

https://github.com/JetBrains/svg-sprite-loader#extract-default-false-autoconfigured

1import FacebookSprite from './assets/facebook.sprite.svg'
2import TwitterSprite from './assets/twitter.sprite.svg'
3import TwitterSpriteURL from './assets/twitter.sprite.svg?URL'
4import wikipedia from './assets/wikipedia.svg'
5
6// FacebookSprite will be a valid vue component, use it as an vue component
7// It will be render as an normal img or svg tag with src to an an independent svg file(include all svg sprite)
8
9console.log(FacebookSprite)
10// render as: <svg><use xlink:href="/static/sprite.svg#facebook.sprite-usage"></use></svg>
11// render as img: <img src="/static/sprite.svg#twitter.sprite--url-usage">
12
13console.log(TwitterSprite)
14// render as: <svg><use xlink:href="/static/sprite.svg#twitter.sprite-usage"></use></svg>
15
16// TwitterSpriteURL will be an normal url, use it as normal image asset in html img tag or css background-image
17console.log(TwitterSpriteURL)
18// log as: /static/sprite.svg#twitter.sprite--url-usage
19
20// wikipedia still be an normal asset, use it as normal image asset in html img tag or css background-image
21
22console.log(wikipedia)
23// log as: /static/img/wikipedia.77b80eb8.svg

Config

May be need to install related loaders, such as:

svgo-loader

1// vue.config.js
2const SpriteLoaderPlugin = require('svg-sprite-loader/plugin')
3
4module.exports = {
5  assetsDir: 'static',
6  configureWebpack: {
7    plugins: [
8      // NOTE: for extract mode, un support https://github.com/JetBrains/svg-sprite-loader#plain-sprite
9      new SpriteLoaderPlugin()
10    ]
11  },
12  chainWebpack: config => {
13    // default file-loader
14    config.module.rule('svg')
15      .exclude.add(/\.sprite\.(svg)(\?.*)?$/).end()
16
17    // add svg-sprite-loader
18    config.module.rule('svg-sprite')
19      .test(/\.sprite\.(svg)(\?.*)?$/)
20      .use('svg-sprite-loader').loader('svg-sprite-loader').tap(() => {
21        return {
22          runtimeGenerator: require.resolve('svg-sprite-vue-generator'),
23          runtimeOptions: {
24            // default render svg tag, set it true to render img tag
25            extractCompTagImg: false,
26          },
27          extract: true,
28          publicPath: '/static/'
29        }
30      }).end()
31      .use('svgo-loader').loader('svgo-loader')
32  }
33}

TypeScript

add module declare for typescript.

1declare module "*.sprite.svg" {
2  import Vue, { VueConstructor } from 'vue'
3  const content: VueConstructor<Vue>
4  export default content
5}

Runtime Options

Use runtime options to config more

1{
2  // default render svg tag, set it true to render img tag in extract mode
3  extractCompTagImg: false,
4  // bind any attributes, default is empty
5  attrs: {},
6  // set loading class, default is 'svg-sprite-loading'
7  loadingClass: '',
8  // set any class string, default is ''
9  otherClass: '',
10}

Note

Can not use inline and extract mode together
May be you can use just extract mode for all svg file

Demo

1npm run demo:serve

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

101 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-29xr-v42j-r956
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More