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-plugin-spriteify

v0.2.1

Published

Vite plugin that integrated sly with vite

Downloads

86

Readme

vite-plugin-spriteify

vite-plugin-spriteify is a Vite plugin designed to generate a spritesheet with icons from a directory. It automatically updates whenever there are changes (edit, delete, add) in the specified directory being watched. Additionally, it offers the option to generate TypeScript types for the outputted icon names.

Installation

npm install -D vite-plugin-spriteify

Usage

Configuration

To use vite-plugin-spriteify, add it to your Vite configuration file (vite.config.js) as a plugin:

// vite.config.js
import { spriteify } from 'vite-plugin-spriteify';

export default {
  plugins: [
    spriteify({
      inputDir: "icons",
      outputDir: "public/icons",
      fileName: "icons.svg", // optional, default is "sprite.svg"
      typesFileName: "name.d.ts", // optional, default is "types.ts"
      grouped: true, // default false, true if you want to group icons by directory
      withTypes: true, // set it true if you want to generate TypeScript types
      cwd: process.cwd(),
    }),
  ],
};

Example Component

Once the spritesheet is generated, you can use the icons in your components. Here's an 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>
  )
}

Using the Component

You can now use the Icon component in your JSX by passing the icon name as a prop:

<Icon name="plus" />

This will render the icon named "plus" from the spritesheet.