Skip to content

slightlytyler/react-svgcon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React SVGcon

Use SVGs as icons.

Usage

npm install react-svgcon --save

With webpack raw-loader set up to handle the icon SVGs. Usage should look like:

import Icon from 'react-svgcon';
import someIcon from 'assets/some-icon.svg';

// ...

<Icon
  svg={someIcon}
  width="20px"
  height="25px"
  color="#4cd695"
/>

Options

svg

Raw string representing the SVG.

width and height

Sets the width and height. By default the aspect ratio will be preserved. You can use preserveAspectRatio to override this behavior. These properties have no effect when there is no viewBox set on the SVG element.

viewBox

Usually you don't have to set this property unless the original SVG doesn't define a viewBox. In that case, width and height won't work. You will have to set a viewBox like "0 0 originalWidth originalHeight"

preserveAspectRatio

Set this property to "none" if you want to squash the icon. You can set it to any other valid SVG attribute. Default is "xMidYMid meet".

color

Overrides fill and stroke styles with the provided color unless it is set to none in the original SVG. If you need a more fine grained control, you can pass a function for this property, which returns a color:

function chooseColor(type, original) {
  var colorString = '#000';

  // type is 'fill' or 'stroke'
  if (type === 'fill') {
    ...
  }

  // the original color in the svg
  if (original === '#fff') {
    ...
  }

  return colorString;
}

<Icon name='icon-name' color={chooseColor} />

other options

Of course you can pass any other standard property, such as style and event handlers. Icon can be colorized using the style attr color on the Icon element.

About

React component for using SVGs as icons

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%