npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@evo/react-embed-svg

v1.0.2

Published

React component that loads content of an SVG file

Downloads

76

Readme

EmbedSVG

React component to load and embed content of a SVG file into specified container.

Usage

Example of usage:

import EmbedSVG from '@evo/EmbedSVG';

const Example = () => (
    <EmbedSVG
        src='related/path/to/image.svg'
        container={this.container}
        className='svg-icon'
        onLoad={(svgText) => svgText}
        onError={(event) => { ... }}
    />
);

Dependencies

The following dependencies should be installed in the project that will use this component:

"peerDependencies": {
    "react": ">=16.4.2",
    "react-dom": ">=16.4.2",
    "prop-types": ">=15.5.10"
},

API

EmbedSVG component has following options:

src

type: string;

This property is required. It is related path to SVG file.

container

type: object;

default: null;

This property is not required. It is a DOM element. Content of the SVG file will be loaded into this DOM element. If it's not setted the content of the SVG file won't be embed anywhere.

className

type: string;

default: null;

This property is not required. Value of this property will be added to <svg> tag.

onLoad

type: function;

default: (rawSVG) => rawSVG;

This property is not required. Function will be executed after SVG file loading. It takes the single argument rawSVG (content of the SVG file as string). This function should return content of the SVG file as string otherwise result won't be embed into container.

onError

type: function;

default: null;

This property is not required. Function will be executed only after SVG file loading fail. It takes the single argument event (for more information see developer.mozilla.org).