@myeasyfarm/vite-plugin-icons-spritesheet

A Vite plugin to generate a spritesheet with icons from a directory, re-runs on every edit/delete/add to the directory that is being watched.

Optionally generates TypeScript types for the icon names that it outputs.

If you want to learn more about this approach and it's benefits check it out here: https://www.jacobparis.com/content/svg-icons

About This Fork

This is a fork of the original vite-plugin-icons-spritesheet project. The original maintainer is no longer actively developing the library and is not accepting pull requests. To ensure continued development, bug fixes, and new features, we have decided to maintain and develop this project separately under the @myeasyfarm scope.

We extend our gratitude to the original author and contributors for creating this excellent tool. This fork aims to build upon their work while keeping the library up-to-date and actively maintained.

Key Changes from Original

• ESM-only: This package is published as ESM-only (no CommonJS support). Make sure your project supports ES modules. If you need CommonJS support, please use the original package.
• SVG formatting: We don't attempt to format the output SVG file with Biome or Prettier, as neither tool supports SVG input. Applying HTML formatting to SVG files would be misusing these formatters, as they are not designed for this file type.
• Node.js >= 22 required: This package uses Node.js native globSync API instead of the external glob package, which requires Node.js 22 or higher. If you have an older Node version, please use the original package.

Installation

npm install -D @myeasyfarm/vite-plugin-icons-spritesheet

Usage

// vite.config.js
import { iconsSpritesheet } from '@myeasyfarm/vite-plugin-icons-spritesheet';

export default {
  plugins: [
     iconsSpritesheet({
      // Defaults to false, should it generate TS types for you
      withTypes: true,
      // The path to the icon directory
      inputDir: "icons",
      // Output path for the generated spritesheet and types
      outputDir: "public/icons",
      // Output path for the generated type file, defaults to types.ts in outputDir
      typesOutputFile: "app/icons.ts",
      // The name of the generated spritesheet, defaults to sprite.svg
      fileName: "icon.svg",
      // The cwd, defaults to process.cwd()
      cwd: process.cwd(),
      // What formatter to use to format the generated files, prettier or biome, defaults to no formatter
      formatter: "biome",
      // Callback function that is called when the script is generating the icon name
      // This is useful if you want to modify the icon name before it is written to the file
      iconNameTransformer: (iconName) => iconName
    }),
  ],
};

You can also pass an array of configs to the plugin to generate multiple spritesheets and types files at the same time (and watch those folders for changes).

// vite.config.js
import { iconsSpritesheet } from '@myeasyfarm/vite-plugin-icons-spritesheet';

export default {
  plugins: [
     iconsSpritesheet([
      { 
        withTypes: true, 
        inputDir: "icons/subset1", 
        outputDir: "public/icons1", 
        typesOutputFile: "app/icons1.ts", 
        fileName: "icon1.svg", 
      },
      { 
        withTypes: true, 
        inputDir: "icons/subset2",
        outputDir: "public/icons2", 
        typesOutputFile: "app/icons2.ts", 
        fileName: "icon2.svg", 
      },
    ]),
  ],
};

Example component file:

import spriteHref from "~/path/sprite.svg"
import type { SVGProps } from "react"
import type { IconName } from "~/path/types.ts"

export function Icon({
  name,
  ...props
}: SVGProps<SVGSVGElement> & {
  name: IconName
}) {
  return (
    <svg {...props}>
      <use href={`${spriteHref}#${name}`} />
    </svg>
  )
}

Component usage:

<Icon name="plus" />