react-svg

A React component that injects SVG into the DOM.

Background | Basic Usage | Live Examples | API | Installation | FAQ | License

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 @tanem/svg-injector, 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 { createRoot } from 'react-dom/client'
import { ReactSVG } from 'react-svg'

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

Live Examples

• Accessibility: Source | Sandbox
• API Usage: Source | Sandbox
• Basic Usage: Source | Sandbox
• Before Injection: Source | Sandbox
• CSS Animation: Source | Sandbox
• CSS-in-JS: Source | Sandbox
• External Stylesheet: Source | Sandbox
• Fallbacks: Source | Sandbox
• Iframe: Source | Sandbox
• Loading: Source | Sandbox
• No Extension: Source | Sandbox
• SSR: Source | Sandbox
• Styled Components: Source | Sandbox
• SVG Wrapper: Source | Sandbox
• Typescript: Source | Sandbox
• UMD Build (Development): Source | Sandbox
• UMD Build (Production): Source | Sandbox

API

Props

• src - The SVG URL.
• afterInjection(svg) - Optional Function to call after the SVG is injected. svg is the injected SVG DOM element. If an error occurs during execution it will be routed to the onError callback, and if a fallback is specified it will be rendered. 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. If an error occurs during execution it will be routed to the onError callback, and if a fallback is specified it will be rendered. 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 error occurs during injection, or if errors are thrown from the beforeInjection or afterInjection functions. Can be a string, class component, or function component. Defaults to null.
• httpRequestWithCredentials - Optional Boolean indicating if cross-site Access-Control requests for the SVG should be made using credentials. Defaults to false.
• loading - Optional Component to use during loading. Can be a string, class component, or function component. Defaults to null.
• onError(error) - Optional Function to call if an error occurs during injection, or if errors are thrown from the beforeInjection or afterInjection functions. error is an unknown object. Defaults to () => {}.
• renumerateIRIElements - Optional Boolean indicating if SVG IRI addressable elements should be renumerated. Defaults to true.
• useRequestCache - Optional Use SVG request cache. Defaults to true.
• wrapper - Optional Wrapper element types. One of 'div', 'span' or 'svg'. Defaults to 'div'.

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

Example

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

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:

• https://unpkg.com/react-svg/dist/react-svg.umd.development.js
• https://unpkg.com/react-svg/dist/react-svg.umd.production.js

For the non-minified development version, make sure you have already included:

• React
• ReactDOM
• PropTypes

For the minified production version, make sure you have already included:

• React
• ReactDOM

FAQ

Why are there two wrapping elements?

This module delegates it's core behaviour to @tanem/svg-injector, which requires the presence of a parent node when swapping in the SVG element. The swapping in occurs outside of React flow, so we don't want React updates to conflict with the DOM nodes @tanem/svg-injector is managing.

Example output, assuming a div wrapper:

<div> <!-- The wrapper, managed by React -->
  <div> <!-- The parent node, managed by @tanem/svg-injector -->
    <svg>...</svg> <!-- The swapped-in SVG, managed by @tanem/svg-injector -->
  </div>
</div>

See:

• Integrating with Other Libraries.

Related issues and PRs:

• #24.
• #30.
• #36.
• #48.

How can I improve the accessibility of the rendered output?

Let's assume we want to add role and aria-label attributes to the outermost wrapper element, plus title and desc elements to the SVG.

Since non-documented properties are applied to the outermost wrapper element, and the beforeInjection function allows us to modify the SVG DOM, we can do something like the following:

<ReactSVG
  aria-label="Description of the overall image"
  beforeInjection={(svg) => {
    const desc = document.createElementNS(
      'http://www.w3.org/2000/svg',
      'desc'
    )
    desc.innerHTML = 'A description'
    svg.prepend(desc)

    const title = document.createElementNS(
      'http://www.w3.org/2000/svg',
      'title'
    )
    title.innerHTML = 'A title'
    svg.prepend(title)
  }}
  role="img"
  src="svg.svg"
/>

A live example is available here.

Related issue:

• #639.

License

MIT