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

bonder

v0.2.4

Published

Creates CSS and SVG sprites.

Downloads

6

Readme

Spriter

Creates sprite images.

  • Generates horizontal, vertical and smart(compact) sprites.
  • Can add images to existent sprites without modifying other images positions.
  • Can get positions from existent sprites for already sprited images and create new sprite for other.

Requirements

Spriter requires node-imagemagick which depends on Imagemagick.

There are many ways to install Imagemagick. For example, if you are using OS X, you can use Homebrew: brew install imagemagick.

Usage

Install with npm:

$ [sudo] npm install spriter --save

If you want to use spriter on your cli install with:

$ [sudo] npm install spriter -g

CLI

Usage:

$ spriter <src> <output> [options...]

src     Glob string(s) or file path(s) to find source images for spriting
output  Output sprite filepath

Options:

    -h, --help : Help
    -v, --version : Version
    -o OUTPUT, --output=OUTPUT : Path of directory to write sprite file to [./sprites]
    -n NAME, --name=NAME : Name of sprite file  [common]
    -e EXTENSION, --ext=EXTENSION : Extension of sprite file  [png]
    -i IFEXISTS, --ifexists=IFEXISTS : Action for already existent sprite  [override]
    -l LAYOUT, --layout=LAYOUT : Layout of the sprite image  [smart]
    -p PADDINGS, --padding=PADDINGS : Tiles padding in px  [2]

Example:

    $ spriter '**/*.png' -o './sprited' -n 'common'

JS API

Usage:

var spriter = require('spriter');

spriter.api(options).then(cb);

Options:

  • src: Glob string(s) or file path(s) to find source images to put into the sprite [required]
  • path: Path of directory to write sprite file to [./sprites]
  • name: Name of sprite file [common]
  • ext: Extension of sprite file [png]
  • ifexists: Action for already existent sprite: override, add or use [override]
  • layout: Layout of the sprite image: smart, horizontal or vertical [smart]
  • padding: Tiles padding in px [2]

Example:

var Spriter = require('spriter');

Spriter
    .api({
        src : [ '**/*.png' ],
        path : './sprited',
        name : 'common'
    })
    .spread(function(images, sprites) {
        console.log('done');
    });

Checkout more examples at /examples and /tests.