@amykate/react-svg
v4.0.18
Published
A React component that uses SVGInjector to add SVG to the DOM.
Downloads
4
Readme
react-svg
My copy of react-svg to use my copy of svg-injector
A React component that uses SVGInjector to add SVG to the DOM.
Basic Usage
import React from 'react'
import { render } from 'react-dom'
import ReactSVG from 'react-svg'
render(<ReactSVG path="svg.svg" />, document.getElementById('root'))
Live Examples
API
:eyes: See MIGRATING.md for moving between major versions of this component.
Props
path
- Path to the SVG.evalScripts
- Optional Run any script blocks found in the SVG. One of'always'
,'once'
, or'never'
. Defaults to'never'
.onInjected
- Optional Function to call after the SVG is injected. Receives the injected SVG DOM element as a parameter. Defaults to() => {}
.svgClassName
- Optional Class name to be added to the injected SVG DOM element. Defaults tonull
.svgStyle
- Optional Inline styles to be added to the injected SVG DOM element. Defaults to{}
.
Other non-documented properties are applied to the wrapper element.
Example
<ReactSVG
path="svg.svg"
evalScripts="always"
onInjected={svg => {
console.log('onInjected', svg)
}}
svgClassName="svg-class-name"
svgStyle={{ width: 200 }}
className="wrapper-class-name"
onClick={() => {
console.log('wrapper onClick')
}}
/>
Installation
$ npm install react-svg --save
There are also UMD builds available via unpkg:
- https://unpkg.com/react-svg/umd/ReactSVG.js
- https://unpkg.com/react-svg/umd/ReactSVG.min.js
For the non-minified development version, make sure you have already included:
For the minified production version, make sure you have already included:
License
MIT