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

vite-svg-sprite-compose

v1.2.0

Published

Vite SVG Sprite Merge Plugin is a Vite plugin that simplifies and automates the merging of multiple SVG icons into a single sprite. It allows you to combine SVG icons from various directories, apply optional SVGO optimization, and generate a unified SVG s

Downloads

76

Readme

Vite-svg-sprite-compose

npm npm

ViteSvgSpriteCompose is a Vite plugin that enables you to easily generate SVG sprite sheets using svg-sprite and optionally optimize the SVG files with svgo.

Base on svg-sprite-compose-cli

Installation

You can install ViteSvgSpritePlugin via npm or yarn:

npm install vite-svg-sprite-compose --save-dev
# or
yarn add vite-svg-sprite-compose --dev

Usage

To use ViteSvgSpritePlugin, add it to your Vite config file (vite.config.js). Here's an example of how to set up the plugin:

import { defineConfig } from "vite";
import ViteSvgSpriteCompose from "vite-svg-sprite-compose";

export default defineConfig({
  plugins: [
    ViteSvgSpriteCompose({
      input: [
        {
          dir: "src/assets/svg",
          svgoConfig: {
            // Add your svgo configuration here (optional).
          },
          enableSvgo: true, // Set to `false` to disable svgo optimization (optional).
        },
        // Add more input directories if needed.
      ],
      output: {
        dir: "public/",
        spriteName: "sprite.svg", // Set the output sprite file name (optional).
        makeIdsArray: true,
      },
      disabled: false, // Set to `true` to disable the plugin (optional).
      defaultSvgoConfig: {
        // Add your default svgo configuration here (optional).
      },
      idPrefix: "", // Add an optional prefix to the SVG IDs (optional).
    }),
  ],
});

The above configuration will process your SVG files, optimize them using svgo if enabled, and create an SVG sprite in the specified output directory.

Configuration Options

import { Config } from "svgo";

type InputConfig = {
  /* Path to directory with svg files */
  dir: string;
  /* SVGO configuration for optimization */
  svgoConfig?: Config;
  /* Skip optimization step */
  enableSvgo?: boolean;
};

type OutputConfig = {
  /* The directory where the SVG sprite will be generated */
  dir: string;
  /* The name of the generated SVG sprite (optional, default is 'sprite.svg'). */
  spriteName?: `${string}.svg`;
  /* Creating json file with svg IDs (optional, default is false). */
  makeIdsArray?: boolean;
  /* File name for json of svg IDs (optional, default is 'sprite-ids.json') */
  idsArrayName?: `${string}.json`;
};

interface PluginConfig {
  /* An array of input directories and their configurations. */
  input: InputConfig[];
  /* The directory where the SVG sprite will be generated */
  output: OutputConfig;
  /* Set to true to disable the plugin (optional, default is false). */
  disabled?: boolean;
  /* Default SVGO configuration for optimization (optional). */
  defaultSvgoConfig?: Config;
  /* An optional prefix to add to SVG IDs. */
  idPrefix?: string;
}

More details svg-sprite-compose-cli

License

This project is licensed under the MIT License.