broccoli-sprite

A broccoli plugin for sprite generation

tl;dr

• Inputs:
  • A list of image files
• Outputs:
  • An image sprite sheet
  • A CSS (support different varieties) file

Installation

npm install broccoli-sprite

Installation dependencies

You will need to install at least one of the following, before installing broccoli-sprite.

• GraphicsMagick
  • On Ubuntu:
    • sudo apt-get install graphicsmagick
  • On Windows:
    • Instructions here
• node canvas
  • Ensure that you have NodeJs v0.10.29 installed
  • On Ubuntu:
    • sudo apt-get install libcairo2-dev libjpeg8-dev libpango1.0-dev libgif-dev build-essential g++
    • npm install -g canvas

Usage

In Brocfile.js, add the following:

var broccoliSprite = require('broccoli-sprite');
var spritesTree = broccoliSprite('public', {
  src: [
    'public/images/sprites/*.png'
  ],
  spritePath: 'assets/sprites.png',
  stylesheetPath: 'assets/sprites.css',
  stylesheet: 'css',
  stylesheetOptions: {
    prefix: 'sprite-',
  },
});

… and be sure to merge spritesTree into the main tree.

Usage in ember-cli apps

To use broccoli-sprite in an ember-cli app:

var app = new EmberApp(/* ... */);
/* other ember-cli init for app */
var broccoliSprite = require('broccoli-sprite');
var spritesTree = broccoliSprite(/* ... */);
var appTree = app.toTree();
var broccoliMergeTrees = require('broccoli-merge-trees');
module.exports = broccoliMergeTrees([spritesTree, appTree]);

Configuration Options

broccoli-sprite warpas around the excellent node-sprite-generator library.

When you call broccoliSprite, it accepts two arguments: tree and options.

tree

This is any broccoli tree. In an ember-cli app, this would most likely be 'public'.

options

These options are passed into node-sprite-generator, so follow the options specified here.

There are a few things to note though:

src is the full path, not the path within the tree. Notice that in the example above, the tree is 'public', and "public" is repeated in the path within src.

The same is not true for output paths though, spritePath and stylesheetPath, which must be speicifed relative to the tree. Notice that "public" is not repeated within these paths.

Licence

GPL v3