New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

react-svg

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-svg

A React component that injects SVG into the DOM.

16.1.32
Source
npm

Version published: last year

Weekly downloads: 122K; decreased by-17.25%

Maintainers: 1

Weekly downloads

Created: 10 years ago

What is react-svg?

The react-svg npm package is a React component that allows you to easily include and manipulate SVG files in your React applications. It provides a simple way to load SVG files and apply various transformations and customizations to them.

What are react-svg's main functionalities?

Basic SVG Loading

This feature allows you to load an SVG file into your React component. The 'src' prop specifies the path to the SVG file.

<ReactSVG src="/path/to/your.svg" />

Customizing SVG with Props

This feature allows you to customize the SVG before it is injected into the DOM. The 'beforeInjection' prop is a function that receives the SVG element and allows you to manipulate it.

<ReactSVG src="/path/to/your.svg" beforeInjection={(svg) => { svg.classList.add('svg-class'); svg.setAttribute('style', 'width: 200px'); }} />

Using SVG as a Component

This feature allows you to use the SVG as a React component, making it easy to include and manage within your React application.

import { ReactSVG } from 'react-svg';

const MyComponent = () => (
  <ReactSVG src="/path/to/your.svg" />
);

Handling SVG Load Events

This feature allows you to handle events when the SVG is loaded. The 'onLoad' prop is a function that is called when the SVG has been successfully loaded.

<ReactSVG src="/path/to/your.svg" onLoad={() => console.log('SVG loaded!')} />

Other packages similar to react-svg

react-svg

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 @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 () => {}.
desc - Optional String used for SVG <desc> element content. If a <desc> exists it will be replaced, otherwise a new <desc> is created. Defaults to '', which is a noop.
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.
title - Optional String used for SVG <title> element content. If a <title> exists it will be replaced, otherwise a new <title> is created. Defaults to '', which is a noop.
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"
  desc="Description"
  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"
  title="Title"
  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:

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

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

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:

License

MIT

Keywords

FAQs

What is react-svg?

Is react-svg popular?

Is react-svg well maintained?

Package last updated on 15 Dec 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

react-svg

What is react-svg?

What are react-svg's main functionalities?

Other packages similar to react-svg

react-svg

Background

Basic Usage

Live Examples

API

Installation

FAQ

License

v16.1.32 (2023-12-15)

:house: Internal

Keywords

Related posts

react-svg

What is react-svg?

What are react-svg's main functionalities?

Other packages similar to react-svg

react-inlinesvg

svgr

react-svg-loader

react-svg

Background

Basic Usage

Live Examples

API

Installation

FAQ

License

v16.1.32 (2023-12-15)

:house: Internal

Keywords

Related posts

Oracle Drags Its Feet in the JavaScript Trademark Dispute

Linux Foundation Warns Open Source Developers: Compliance with Sanctions Is Not Optional

Maven Central Adds Sigstore Signature Validation