PhantomJS engine for spritesmith
This depends on having
phantomjs installed on your machine. This can be done globally as listed on the PhantomJS website or locally via the node module wrapper. This module has been tested against
A phantomjs wrapper can be install via:
npm install phantomjs
When running your
phantomjssmith task, it must have
node_modules/.bin/ in the
PATH environment variable. The easiest way to accomplish this is by using
// Inside our `package.json`"scripts":"build": "grunt sprite"
# Runs `grunt sprite` with `node_modules/.bin/` appended to `PATH`npm run build
Install the module with:
npm install phantomjssmith
// Load in our dependenciesvar Phantomjssmith = require'phantomjssmith';// Create a new enginevar phantomjssmith = ;// Interpret some images from diskphantomjssmithcreateImages'img1.jpg' 'img2.png'// If there was an error, throw itif errthrow err;// We recieve images in the same order they were givenimgs0width; // 50 (pixels)imgs0height; // 100 (pixels)// Create a canvas that fits our images (200px wide, 300px tall)var canvas = phantomjssmithcreateCanvas200 300;// Add the images to our canvas (at x=0, y=0 and x=50, y=100 respectively)canvasaddImageimgs0 0 0;canvasaddImageimgs1 50 100;// Export canvas to imagevar resultStream = canvas'export'format: 'png';resultStream; // Readable stream outputting PNG image of the canvas;
This module was built to the specification for spritesmith engines.
Specification version: 2.0.0
createImages methods supports the following types of images:
String- Filepath to image
Object- Vinyl object with
nullfor image (uses provided filepath)
We accept but don't fully support the following types of images:
Object- Vinyl object with buffer for image (ignores contents, uses provided filepath)
Object- Vinyl object with stream for image (ignores contents, uses provided filepath)
export method provides support for the following options:
Number- Milliseconds to wait until automatically terminating PhantomJS script
String- Output image format to callback with. Currently,
Number- If you are outputting a
jpeg, the quality can be specified from 0 to 100.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint using
npm run lint and test via
Copyright (c) 2013 Todd Wolfson
Licensed under the MIT license.