Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including react-svg with all npm packages installed. Try it out:

require("react/package.json"); // react is a peer dependency. require("react-dom/package.json"); // react-dom is a peer dependency. var reactSvg = require("react-svg")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

react-svg v7.1.0

A React component that injects SVG into the DOM.

react-svg

npm version build status coverage status npm downloads gzip size

A React component that injects SVG into the DOM.

Background

Let's say you have an SVG available at some URL, and you'd like to inject it into the DOM for various reasons. This module does the heavy lifting for you by delegating the process to SVGInjector, which makes an AJAX request for the SVG and then swaps in the SVG markup inline. The async loaded SVG is also cached, so multiple uses of an SVG only require a single server request.

Basic Usage

import React from 'react'
import { render } from 'react-dom'
import ReactSVG from 'react-svg'

render(<ReactSVG src="svg.svg" />, document.getElementById('root'))

Live Examples

API

Props

  • src - The SVG URL.
  • evalScripts - Optional Run any script blocks found in the SVG. One of 'always', 'once', or 'never'. Defaults to 'never'.
  • fallback - Optional Fallback to use if an injection error occurs. Can be a string, class component, or function component. Defaults to null.
  • loading - Optional Component to use during loading. Can be a string, class component, or function component. Defaults to null.
  • onInjected - Optional Function to call after the SVG is injected. If an injection error occurs, this function receives an Error object as the first parameter. Otherwise, the first parameter is null and the second parameter is the injected SVG DOM element. Defaults to () => {}.
  • renumerateIRIElements - Optional Boolean indicating if SVG IRI addressable elements should be renumerated. Defaults to true.
  • svgClassName - Optional Class name to be added to the injected SVG DOM element. Defaults to null.
  • 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
  src="svg.svg"
  evalScripts="always"
  fallback={() => <span>Error!</span>}
  loading={() => <span>Loading</span>}
  onInjected={(error, svg) => {
    if (error) {
      console.error(error)
      return
    }
    console.log(svg)
  }}
  renumerateIRIElements={false}
  svgClassName="svg-class-name"
  svgStyle={{ width: 200 }}
  className="wrapper-class-name"
  onClick={() => {
    console.log('wrapper onClick')
  }}
/>

Installation

$ npm install react-svg

There are also UMD builds available via unpkg:

  • https://unpkg.com/react-svg/umd/react-svg.development.js
  • https://unpkg.com/react-svg/umd/react-svg.production.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:

Credits

Thanks to the author(s) of the original SVGInjector, without which none of this would have been possible :clap:

License

MIT

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free