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

svg-sprite-webpack-plugin

v1.0.4

Published

A Webpack plugin to extract SVGs into a cacheable sprite file

Downloads

387

Readme

SVG Sprite Webpack Plugin

NPM Version Build Status Downloads Stats

Description

A webpack plugin/loader to make SVG <use>-based icon systems easy in Webpack. Creates an SVG sprite with <symbol> tags from imported SVG files, and returns a URL to be passed to an SVG <use> tag. Uses kisenka's svg-sprite-loader for internal transformations (from standalone SVG file to <symbol> tag).

Installation

npm install --save-dev svg-sprite-webpack-plugin

Usage

Webpack config

const IconPlugin = require('svg-sprite-webpack-plugin').plugin;

// NOTE:
// Usage with the included webpack-isomorphic-tools parser requires that
// the extracted filename match this format.
const iconPlugin = new IconPlugin('icons-[hash].svg');

// ... inside the configuration object
{
  module: {
    loaders: [
      {
        test: /\.svg$/,
        loader: iconPlugin.extract(),
      }
    ]
  },
  plugins: [
    iconPlugin,
  ],
}

Webpack isomorphic tools

If using webpack-isomorphic-tools, add this to your config:

const iconParser = require('svg-sprite-webpack-plugin').webpackIsomorphicParser;

{
  assets: {
    svg: {
      extension: 'svg',
      parser: iconParser,
    }
  }
}

In code

An example using React 0.14 or later:

import { Component } from 'react';
import myGreatIcon from './my-great-icon.svg';

class SuperGreatIconComponent extends Component {
  render() {
    return (
      <svg><use xlinkHref={myGreatIcon} /></svg>
    );
  }
}

Suggested development mode config

If you're using the webpack-dev-server, it's advised to not use this plugin, and instead go directly to svg-sprite-loader.

const iconTest = /\.svg$/;
if (DEV) {
  config.module.loaders.push({
    test: iconTest,
    loader: 'svg-sprite',
  });
} else {
  config.module.loaders.push({
    test: iconTest,
    loader: iconPlugin.extract(),
  });
}

Usage Caveats

Internet Explorer

Internet Explorer does not support <use> tags with external references. This has been fixed in Microsoft Edge 13, but until Edge's browser share gets to an acceptable level for you, I suggest using jonathantneal's excellent SVG4Everybody library.

CDNs

<use> tags do not allow cross-origin requests, and from what I could tell, aren't likely to start supporting them any time soon. Because of this, instead of using the output.publicPath webpack config, this library is currently expecting that the generated icons svg will be accessible inside the /static directory on the same domain as the website using the imported icons.

Development

This was originally developed to be used in-house, so I expect there are a number of usecases that are not being adequately covered. Issues and PRs are welcome!

Install dependencies:

npm install --global yarn
yarn install

Make sure any code passes tests and the linter before submitting a PR!

yarn test
yarn run lint

Meta

Distributed under the MIT License. See LICENSE for more information.

Developers:

Jeremy Tice @jetpacmonkey