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

simple-svg-sprite

v1.0.1

Published

A Webpack plugin that generates an SVG sprite

Downloads

769

Readme

simple-svg-sprite

A Webpack plugin for creating an SVG sprite from individual SVG files.

Table of Contents


Installation

Install simple-svg-sprite using npm or yarn as a dev dependency:

npm install --save-dev simple-svg-sprite

OR

yarn add --dev simple-svg-sprite

Usage

Here's how to use the plugin in your Webpack configuration:

// import package 
const { SimpleSVGSprite, GenerateSVGContentHash } = require('simple-svg-sprite');
const svgContentHash = GenerateSVGContentHash('path/to/svgs/folder')

module.exports = {
   // ... other webpack config 
   plugins: [ 
   new SimpleSVGSprite({
      svgFolderPath: 'path/to/svgs/folder',
      spriteOutput: spritemap.${svgContentHash}.svg,
    }),
  ] 
};

Options

| Option | Required | Description | Default |--------|----------|-------------|--------- | svgFolderPath | Yes | The path to SVG images folder | - | spriteOutput | NO | The output sprite name | "spritemap.svg" | prefix | NO | Prefix to each symbol ID | "shape-" | svgoOptions |NO | Custom optimization using SVGO library | {}

Change reference

we need to convert reference from your code to sprite refrence example:

// your code 
<svg>
  <use xlink:href="#shape-sp-delete" />
</svg>
// to
<svg>
  <use xlink:href="spritemap.${svgContentHash}.svg#shape-sp-delete" />
</svg>
  • You don't need to update your code base to this format , you can use Mutation observer to do that OR use custom loader:
// add this rule to your loaders
{
        test: /\.(js|html)$/,
        exclude: [/node_modules/],
        use: {
          loader: path.resolve(__dirname, './custom-loaders/EditSvgHrefLoader'),
          options: {
            svgFileName: `spritemap.${svgContentHash}.svg`,
            prefix: 'shape-',
          },
        },
},

// create EditSvgHrefLoader.js file in custom-loaders folder
custom-loaders/EditSvgHrefLoader.js

const loaderUtils = require('loader-utils');
module.exports = function (source) {
  const { svgFileName, prefix } = loaderUtils.getOptions(this);

  const modifiedSource = source.replace(
    new RegExp(`#${prefix}`, 'g'),
    `${svgFileName}#${prefix}`
  );

  return modifiedSource;
};

Demo

You can see demo here.