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 🙏

© 2026 – Pkg Stats / Ryan Hefner

svg-sprite-gen

v1.0.1

Published

Given a folder of SVGs, it optimizes, inlines, and bundles them into a single SVG-sprite (with <symbol> tags), plus a React hook for easy lookup.

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

hrashkanhrashkan

Keywords

svgspritesvg-spritereactclisvgo

Readme

svg-sprite-gen

A CLI tool to generate an optimized SVG sprite and React hook from a folder of SVG icons.

🚀 Features

  • SVG Optimization: Uses SVGO to compress and clean up individual SVG files.
  • Sprite Generation: Bundles all optimized SVGs into a single <svg> sprite sheet with <symbol> entries.
  • React Integration: Produces a ready-to-use React hook (e.g., useSvgSprite) to inject the sprite into the DOM.
  • Configurable: Customize input directory, output filenames, and hook name via flags.
  • Zero Runtime Dependencies: Pure Node.js implementation, no browser-side library dependencies.

💿 Installation

npm install -g svg-sprite-gen

Requires Node.js v16+.

⚙️ CLI Usage

svg-sprite-gen -i <input-dir> [options]

Options

| Flag | Description | Default | | --------------- | -------------------------------------------------- | -------------- | | -i, --input | Path to source directory containing .svg files | (required) | | -o, --output | Output sprite filename (relative or absolute path) | sprite.svg | | --hook <name> | Name of generated React hook | useSvgSprite | | -V, --version | Show CLI version | — | | -h, --help | Display help information | — |

Examples

Generate a sprite from your icons/ folder:

svg-sprite-gen -i ./icons

Creates sprite.svg and sprite.hook.ts in the current directory.

Specify a custom output path and hook name:

svg-sprite-gen -i ./assets/svg -o public/icons.svg --hook useIconSprite

🛠️ How It Works

  1. Collect SVGs: Uses fast-glob to find all .svg files in the input directory.
  2. Optimize: Runs each SVG through SVGO for minification.
  3. Wrap: Strips outer <svg> tags and wraps content in <symbol id="<filename>">.
  4. Combine: Concatenates all <symbol>s into one <svg> sprite with display: none.
  5. Hook: Generates a React hook that injects the sprite into <body> on mount.

🌀 Development

Clone the repo and install dependencies:

git clone https://github.com/your-username/svg-sprite-gen.git
cd svg-sprite-gen
npm install

Build and link locally:

npm run build
npm link

Run the CLI:

svg-sprite-gen --help

🤝 Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/your-feature
  3. Make your changes and commit: git commit -m "feat: describe your feature"
  4. Push to your branch: git push origin feature/your-feature
  5. Open a Pull Request

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.