react-show-svg

0.10.3 • Public • Published

React show svg

Build Status

Simple react component that transforms plain svg to usable icon.

TL;DR

import React from 'react';
import ReactShowSvg from 'react-show-svg';
import SvgIcon from 'path/to/icon.svg';
 
class App extends React.Component {
  render() {
    return (
      <ReactShowSvg
        size="30px"
        fill="#000000"
        icon={SvgIcon}
      />
    );
  }
}

NPM

$ npm install react-show-svg --save

Yarn

$ yarn add react-show-svg

Usage

Import raw svg file with svg-inline-loader and pass it as icon property.

You can also pass width & height or size properties ( pass size if you want width & height to be equal ).

IMPORTANT - Update your webpack config file:

const config = {
  module: {
    rules: [
      {
        test: /\.svg$/,
        use: [
          {
            loader: 'svg-inline-loader'
          }
        ]
      }
    ]
  }
}

API

  • icon: string
  • width: string
  • height: string
  • size: string ( width & height )
  • fill: string
  • className: string
  • onClick: function
  • ref: function
  • id: string

Dependencies

Readme

Keywords

none

Package Sidebar

Install

npm i react-show-svg

Weekly Downloads

2

Version

0.10.3

License

MIT

Unpacked Size

11.8 kB

Total Files

11

Last publish

Collaborators

  • dinodsaurus
  • crotweet