npmpackage.info

Gathering detailed insights and metrics for svg-transform-loader

Other packages similar to svg-transform-loader

@bolt/svg-transform-loader

5.9.0

Bolt Design System Webpack loader to help with converting colors / attributes in SVG icons

@andylacko/vite-svg-react-loader

3.0.16

Vite plugin to transform SVGs into React components by default using svgr.

@mapbox/svg-react-transformer-loader

2.1.0

Webpack loader to transform SVG files into React components

jest-svg-sprite-loader

1.0.1

A svg-sprite-loader transform for jest (mock)

Gathering detailed insights and metrics for svg-transform-loader

svg-transform-loader - 2.0.13 | npmpackage.info

svg-transform-loader

Node.js toolset for generating & transforming SVG images and sprites in modern way

2.0.13

175

MIT

JavaScript

79.89 kB

4,047,833 1.7

Installations

npm install svg-transform-loader

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.19.0

NPM Version

lerna/3.20.2/node@v10.19.0+x64 (darwin)

Pull Requests

Open

46

Total

101

Closed

39

Merged

16

Issues

Open

17

Total

63

Closed

46

Releases

Unable to fetch releases

Languages

JavaScript

CSS

HTML

EJS

JavaScript (97.31%)

CSS (1.44%)

HTML (0.98%)

EJS (0.27%)

Developer

JetBrains

Download Statistics

Total Downloads

4,047,833

Last Day

1,554

Last Week

8,365

Last Month

38,138

Last Year

571,358

GitHub Statistics

MIT License

175 Stars

656 Commits

42 Forks

9 Watchers

50 Branches

55 Contributors

Updated on Apr 08, 2025

Bundle Size

248.00 kB

Minified

79.89 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 55 Contributors

Package Meta Information

Latest Version

2.0.13

Package Id

svg-transform-loader@2.0.13

Size

5.98 kB

NPM Version

lerna/3.20.2/node@v10.19.0+x64 (darwin)

Node Version

10.19.0

Published on

Apr 27, 2020

Total Downloads

Cumulative downloads

Total Downloads

4,047,833

Last Day

13.5%

1,554

Compared to previous day

Last Week

-4.6%

8,365

Compared to previous week

Last Month

-13.4%

38,138

Compared to previous month

Last Year

-21.4%

571,358

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

loader-utils lodash.isempty merge-options postcss posthtml-transform postsvg query-string svg-mixer-utils

Dev Dependencies

css-loader extract-text-webpack-plugin file-loader postcss-loader svg-mixer-test webpack

svg-transform-loader

Webpack loader to add/modify tags and attributes in SVG image. Main purpose - fill, stroke and other manipulations with image imported from CSS/SCSS/LESS/Stylus/PostCSS.

Demo
Installation
Webpack config
Further SVG handling
How to pass transform parameters
Configuration
⚠Important notices

Demo

Fill image with white color:

1.img {
2  background-image: url('./img.svg?fill=#fff');
3}

Stroke image by using variable in SCSS:

1$stroke-color: #fff;
2
3.img {
4  background-image: url('./img.svg?stroke=#{$stroke-color}');
5}

When used with postcss-move-props-to-bg-image-query it is possible to specify transform parameters as usual CSS declarations:

1.img {
2  background-image: url('./img.svg');
3  -svg-fill: red;
4  -svg-stroke: black;
5}

Installation

npm install svg-transform-loader

Webpack config

It's safe to pass all SVGs through this loader, if no transform params presented it just returns original source.

Transform parameters are passed via query string, so match rule for svg files should consider this:

1module.exports = {
2  module: {
3    rules: [
4      {
5        test: /\.svg(\?.*)?$/, // match img.svg and img.svg?param=value
6        use: [
7          'url-loader', // or file-loader or svg-url-loader
8          'svg-transform-loader'
9        ]
10      }
11    ]
12  }
13}

Further SVG handling

Don't forget that this loader leaves any further SVG processing to your choice. You can use:

url-loader/svg-url-loader to inline the SVG into CSS.
file-loader to save SVG as a file (read the notice).

How to pass transform parameters

Transform parameter has following syntax: attr_name=attr_value optional_selector.
Multiple values can be specified by separating them with comma: fill=red .path1, blue .path2.
Parameters can be combined: fill=red&stroke=black.

1.img {background-image: url('./img.svg?fill=#fff')}
2
3/* Fill all <path/> tags */
4.img {background-image: url('./img.svg?fill=#fff path')}
5
6/* Fill all <path/> tags, stroke element with id="qwe" */
7.img {background-image: url('./img.svg?fill=#fff path&stroke=black #qwe')}

Recommended: postcss-move-props-to-bg-image-query

It is possible to write parameters as usual style declarations in CSS and this plugin will turn them into background image query params:

1.img {
2  background-image: url('./img.svg');
3  -svg-fill: #ffffff path, blue circle;
4  -svg-stroke: #ede;
5}
6
7/* turns into */
8.img {
9  background-image: url('./img.svg?fill=%23ffffff%20path%2C%20blue%20circle&stroke=%23ede');
10}

For more info read plugin docs.

Configuration

`raw`

Type: boolean
Default: true

By default loader returns transformed image as-is, which is convenient for further processing with file-loader (e.g. to create a separate file), or url-loader/svg-url-loader (to inline it in CSS code). However, sometimes you might need to get the image as a module (like, for rendering with React). In this case, you'll need to set raw: false.

`transformQuery`

TODO

⚠ Important notices

Usage with css-loader

Note that when using css-loader to handle CSS, sharp # symbol in image query params should be encoded, because css-loader will treat it as fragment identifier part of URL:

1.img {background-image: url(img.svg?fill=#f0f)}
2
3/* will be treated as */
4.img {background-image: url(img.svg?fill=)}

To work around this you have several options.

Recommended: use PostCSS plugin postcss-move-props-to-bg-image-query. See more details in corresponding section.

Use special loader to encode sharp in CSS imports. svg-transform-loader comes with special loader which can be used to encode sharp in CSS imports. This loader should be defined before css-loader and after any other style loaders (webpack call loaders from right to left). Please note that css-loader importLoaders option should be set to 1 or higher:

1// webpack.config.js
2module.exports = {
3  module: {
4    rules: [
5      {
6        test: /\.svg(\?.*)?$/, 
7        use: [
8          'url-loader',
9          'svg-transform-loader' 
10        ]
11      },
12      {
13        test: /\.scss$/,
14        use: [
15          {
16            loader: 'css-loader',
17            options: {
18              importLoaders: 1 // This option should be set to work with encode-query loader
19            }
20          },
21          'svg-transform-loader/encode-query', // loader should be defined BEFORE css-loader
22          'sass-loader' // but AFTER any other loaders which produces CSS
23        ]
24      }
25    ]
26  }
27}

Encode loader uses PostCSS under the hood, so if you already have it on the project it's better to use postcss-move-props-to-bg-image-query to avoid double parsing and performance downgrade.

Encode sharp manually. Replace # with %23 directly in import:
```
1.img {background-image: url(img.svg?fill=%23f0f)}
```

Use preprocessor mixin. If style preprocessor is used, sharp encoding can be automated via mixin. Example of SCSS mixin:

1@mixin fill-background-image($url, $color) {
2  $base-color: str-slice(inspect($color), 2);
3  background-image: unquote('url("' + $url + "?fill=%23" + $base-color +'")');
4}
5
6/* and use it like this */
7$hex-color: #e6e6e6;
8
9.img {
10  @include fill-background-image('img.svg', $hex-color);
11}

Usage with resolve-url-loader

If you're using resolve-url-loader for rewriting paths in SCSS/LESS/etc, keep in mind that it will remove query string by default and svg-transform-loader will not be able to handle the image. To fix this set keepQuery resolve-url-loader option to true:

1{
2  test: /\.scss$/,
3  use: [
4    'css-loader',
5    {
6      loader: 'resolve-url-loader',
7      options: {
8        keepQuery: true // <- this!
9      }
10    },
11    'sass-loader'
12  ]
13}

Usage with file-loader

Keep in mind that you should use [hash] token in file-loader name option, otherwise webpack will create only 1 file per SVG image.

LICENSE

MIT

No vulnerabilities found.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

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

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

CII-Best-Practices

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

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

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

114 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
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-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
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-4xcv-9jjx-gfj3
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
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-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-897m-rjf5-jp39
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
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-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-29xr-v42j-r956
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-3329-pjwv-fjpg
Warn: Project is vulnerable to: GHSA-p6j9-7xhc-rhwp
Warn: Project is vulnerable to: GHSA-89gv-h8wf-cg8r
Warn: Project is vulnerable to: GHSA-gcv8-gh4r-25x6
Warn: Project is vulnerable to: GHSA-gmv4-r438-p67f
Warn: Project is vulnerable to: GHSA-8h2f-7jc4-7m3m
Warn: Project is vulnerable to: GHSA-3vjf-82ff-p4r3
Warn: Project is vulnerable to: GHSA-g694-m8vq-gv9h
Warn: Project is vulnerable to: GHSA-v4rh-8p82-6h5w
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q

Score

1.7

/10

Last Scanned on 2025-05-05

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