node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »


grunt-spriter Build Status

Analyzes your existing CSS files and either generates highly optimized sprite sheets using a growing binary tree bin-packing algorithm or inlines them using data URIs and outputs an updated CSS stylesheet.

It even groups your retina and non-retina images into separate sprite sheets to reduce load times.

Based on spriter.

Getting Started

This plugin requires Grunt ~0.4.0.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

To install Cairo library, check out the node-canvas wiki.

npm install grunt-spriter --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:


The "spriter" task


In your project's Gruntfile, add a section named spriter to the data object passed into grunt.initConfig().

  spriter: {
    options: {
      // Task-specific options go here. 
    your_target: {
      // Target-specific file lists and/or options go here. 



Type: String Default value: images/generated/

Sprite's output path relative to destination or options.source path (required unless generating inline).


Type: String Default value: no

Source path relative to input.


Type: String or Array Default value: no

Source url(s) filter (e.g: images/sprites).


Type: Boolean Default value: false

Just inline images as data URIs.


Type: Boolean Default value: true

Disable rule optimization.


Type: String Default value: sprite

Name of the output sprite sheet file (used if filter isn't specified).

Usage Examples

Outputs two sprites (i/icons.png and i/buttons.png):

  spriter: {
    dist: {
      options: {
        targetPath: 'i/',
        filter: ['../i/icons/', '../i/buttons/']
      src: 'css/main.css',
      dest: 'css/main.css'


In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.


Copyright (c) 2013 Dmitry Nikitenko. Licensed under the MIT license.