Skip to content
🎨 A React component that injects SVG into the DOM.
Branch: master
Clone or download
Latest commit 1aa61aa May 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
scripts/jest Refactor tooling Apr 22, 2019
src Add beforeInjection prop and rework existing API May 5, 2019
test Update beforeInjection test and examples May 5, 2019
.eslintignore Refactor tooling Apr 22, 2019
.eslintrc.js Refactor tooling Apr 22, 2019
.gitignore Refactor tooling Apr 22, 2019
.mailmap Add authors script Jul 23, 2018
.nvmrc Use lts node version Jun 30, 2018
.prettierignore Refactor tooling Apr 22, 2019
.prettierrc.json Follow redux code style Apr 5, 2018
.size-snapshot.json Add beforeInjection prop and rework existing API May 5, 2019
.travis.yml Tidy up Travis conf Jul 25, 2018
AUTHORS
CHANGELOG.md Release v10.0.4 May 23, 2019
LICENSE Add email to LICENSE Jul 25, 2018
MIGRATION.md Add beforeInjection prop and rework existing API May 5, 2019
README.md Add before-injection example May 10, 2019
codecov.yml Stop codecov PR comments Aug 22, 2018
index.js Refactor tooling Apr 22, 2019
package-lock.json Release v10.0.4 May 23, 2019
package.json Release v10.0.4 May 23, 2019
renovate.json Pin dev dependencies Apr 22, 2019
rollup.config.js Refactor tooling Apr 22, 2019
tsconfig.base.json Refactor tooling Apr 22, 2019
tsconfig.json Refactor tooling Apr 22, 2019

README.md

react-svg

npm version build status coverage status npm downloads

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.
  • afterInjection(err, svg) - Optional Function to call after the SVG is injected. If an injection error occurs, err is an Error object. Otherwise, err is null and svg is the injected SVG DOM element. Defaults to () => {}.
  • beforeInjection(svg) - Optional Function to call just before the SVG is injected. svg is the SVG DOM element which is about to be injected. Defaults to () => {}.
  • 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.
  • renumerateIRIElements - Optional Boolean indicating if SVG IRI addressable elements should be renumerated. Defaults to true.
  • wrapper - Optional Wrapper element types. One of 'div' or 'span'. Defaults to 'div'.

Other non-documented properties are applied to the outermost wrapper element.

Example

<ReactSVG
  src="svg.svg"
  afterInjection={(error, svg) => {
    if (error) {
      console.error(error)
      return
    }
    console.log(svg)
  }}
  beforeInjection={svg => {
    svg.classList.add('svg-class-name')
    svg.setAttribute('style', 'width: 200px')
  }}
  evalScripts="always"
  fallback={() => <span>Error!</span>}
  loading={() => <span>Loading</span>}
  renumerateIRIElements={false}
  wrapper="span"
  className="wrapper-class-name"
  onClick={() => {
    console.log('wrapper onClick')
  }}
/>

Installation

⚠️This library depends on @tanem/svg-injector, which uses Array.from(). If you're targeting browsers that don't support that method, you'll need to ensure an appropriate polyfill is included manually. See this issue comment for further detail.

$ npm install react-svg

There are also UMD builds available via unpkg:

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

You can’t perform that action at this time.