npmpackage.info

Gathering detailed insights and metrics for react-svg-icon-generator

Other packages similar to react-svg-icon-generator

typescript-react-svg-icon-generator

1.1.9

typescript-react-svg-icon-generator

react-svg-icon-generator-v2

0.0.5

Generate React Icon Component from SVG icons to show, resize and recolor them.

react-svg-icon-generator-standardmetrics

0.5.4

Generate React Icon Component from SVG icons to show, resize and recolor them.

react-svg-icon-generator-ts

0.0.3

Generate React Icon Component from SVG icons to show, resize and recolor them.

Gathering detailed insights and metrics for react-svg-icon-generator

react-svg-icon-generator - 0.5.2 | npmpackage.info

react-svg-icon-generator

Generate React Icon Component from SVG icons to show, resize and recolor them.

0.5.2

MIT

JavaScript

37.86 kB

2.4

Installations

npm install react-svg-icon-generator

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

11.10.1

NPM Version

6.8.0 Pull Requests

Open

10

Total

35

Closed

0

Merged

25

Issues

Open

5

Total

13

Closed

8

Releases

Move Radium to peerDependecies

0.1.7

Updated on Apr 17, 2016

View All 1 releases

Languages

JavaScript

JavaScript (100%)

Developer

blueberryapps

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

64 Stars

98 Commits

21 Forks

25 Watchers

13 Branches

18 Contributors

Updated on Feb 05, 2024

Maintainers

View All 18 Contributors

Package Meta Information

Latest Version

0.5.2

Package Id

react-svg-icon-generator@0.5.2

Unpacked Size

37.86 kB

Size

10.81 kB

File Count

NPM Version

6.8.0

Node Version

11.10.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

bluebird invariant nunjucks svgo yargs

Dev Dependencies

babel babel-core babel-eslint babel-loader escope eslint eslint-config-airbnb eslint-plugin-react expect gulp mocha rimraf

React SVG Icon Generator

Generate React Icon Component from SVG icons to show, resize and recolor them.

We have prepared live demo for you at React SVG Icon Live Generator

📱Supports React Native 💕

Fastest way to get your svg converted to React Component

yarn global add react-svg-icon-generator
yarn svg-icon-generate -- --svgDir ./icons --destination ./Icon.tsx

for detailed options run just yarn react-svg-icon-generator

Preview of Generated Component

source directory with SVG and this is output component from gulp task so in production you are without any dependencies at all.

Instalation

you need to add this just to development, because it will generate self contained react component directly to your codebase

1npm install --save-dev react-svg-icon-generator

Setup gulp task simple

1const configureSvgIcon = require('react-svg-icon-generator').default;
2
3configureSvgIcon({
4  destination: path.join(__dirname, 'components', 'Icon.js'),
5  svgDir: './icons',
6});

svgDir (required) - path to your directory with svg files. Can be relative path but it is better to use path.join(__dirname, 'icons') absolute path so it will work in any directory of project
destination (required) - path.join(__dirname, 'components', 'Icon.js')

run it by gulp svg-icon

Setup gulp task full

1const configureSvgIcon = require('react-svg-icon-generator').default;
2
3configureSvgIcon({
4  comment: 'Generated by gulp svg-icon, if you add new icon run gulp svg-icon',
5  componentName: 'Icon',
6  destination: path.join(__dirname, 'components', 'Icon.js'),
7  keepFillColor: false,
8  native: false,
9  radium: true,
10  reactPureRender: true,
11  svgDir: path.join(__dirname, 'icons'),
12  template: path.join(__dirname, 'template', 'icon.nunjucks'),
13});

comment (optional) - it will be added to generated component, so other developer will know what to do
componentName (optional) - it will change the name of the component, default to 'Icon'
keepFillColor (optional) - it will keep the original fill color from imported SVG in case you want to use multiple colors in your icon, therefore you will not be able to use color prop
native (optional) - it will generate component that can be used in React Native projects. This functionality depends on react-native-svg library that has to be installed separately (it is not included in dependencies). You can easily overwrite default native template using template option
reactPureRender (optional) - it will use import {PureComponent} from 'react'; instead of import {Component} from 'react';. If you use this, make sure you use React >= v15.3.0.
radium (optional) - it will import radium and wrap Icon component with Radium wrapper. In order to use Radium it has to be installed separately (it is not part of dependencies).
template (optional) - provide path to your custom template, you can look at example at Icon.template

run it by gulp svg-icon

Setup gulp task own name

1const {configureGenerator} = require('react-svg-icon-generator').default;
2
3const config = {
4  comment: 'Generated by gulp svg-icon, if you add new icon run gulp svg-icon-whatever',
5  destination: path.join(__dirname, 'components', 'Icon.js'),
6  reactPureRender: true,
7  svgDir: path.join(__dirname, 'icons'),
8  template: path.join(__dirname, 'template', 'icon.nunjucks'),
9}
10
11gulp.task('svg-icon-whatever', configureGenerator(config));

same as previous + your own task name

Use generate Icon component

1import React, {Component} from 'react';
2import Icon from './Icon';
3
4export default class App extends Component {
5  render() {
6    return (
7      <div>
8        Simple possible usage
9        <Icon kind='clock' />
10
11        Setup color and bounding width and height
12        <Icon kind='close' color='#748' width={500} height={100} />
13
14        Setup color and bounding width and height to size (square)
15        <Icon kind='close' color='red' size={600} />
16
17        Setup custom style and className
18        <Icon kind="arrow_left" style={{transform: 'scaleX(-1)'}} className="custom-class" />
19
20        Setup onClick behavior
21        <Icon kind='close' onClick={() => alert('clicked on icon')} />
22
23        Show all icons at once with description (for finding right icon)
24        <Icon preview />
25      </div>
26    );
27  }
28}

any prop which is not listed will be passed directly to svg as rest props.

Development

1git clone git@github.com:blueberryapps/react-svg-icon-generator.git
2cd react-svg-icon
3npm i
4npm link
5cd examples/simple
6npm link react-svg-icon-generator
7npm i
8gulp svg-icon
9npm start
10open http://127.0.0.1:3000

Thanks

This package was build upon Library Boilerplate from Dan Abramov

Made with love by

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.

5

Code-Review

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

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

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

101 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
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-qrmc-fj45-qfc2
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-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-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-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-hxm2-r34f-qmc5
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-x77j-w7wf-fjmw
Warn: Project is vulnerable to: GHSA-28xh-wpgr-7fm8
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-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
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-pv4c-p2j5-38j4
Warn: Project is vulnerable to: GHSA-46c4-8wrp-j99v
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-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-cf66-xwfp-gvc4
Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-832h-xg76-4gv6
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-mpcf-4gmh-23w8
Warn: Project is vulnerable to: GHSA-9qj9-36jm-prpv
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-wrvr-8mpx-r7pp
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-gqgv-6jq5-jjj9
Warn: Project is vulnerable to: GHSA-hxcm-v35h-mg2x
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472

Score

2.4

/10

Last Scanned on 2025-07-07

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