Encode a directory of PNG or SVG images to CSS
Install the module with: npm install directory-encoder
var DirectoryEncoder = require('directory-encoder');
var de = new DirectoryEncoder( source, destinationCSSFile, {
pngfolder: pngfolder, //in case you need to link out for PNGs,
like when the datauri is way too long
customselectors: { "foo": [".bar", ".baz"]},
prefix: ".icon-", // used to prefix the name of the file for the CSS classname, .icon- is the default
template: template.hbs, //template in handlebars, FANCY!
noencodepng: false // turn this to true if you want no datauris
for pngs, just links out to png files
});
de.encode(); // "Guitar solo -- File outputted"
Takes three arguments, source directory for encoding, destination css file for when it writes, and an options hash that includes a spot for customselectors, a hbs template in case you want to get nuts with your css, where the pngs are located if you want to link out to them (or you don't have a choice because the data uri is bigger than 32k), and a switch to turn off datauris for pngs.
All the magic happens here.
var de = new DirectoryEncoder( source, destinationCSSFile, {
pngfolder: pngfolder, //in case you need to link out for PNGs,
like when the datauri is way too long
customselectors: { "foo": [".bar", ".baz"]},
template: template.hbs, //template in handlebars, FANCY!
noencodepng: false // turn this to true if you want no datauris
for pngs, just links out to png files
});
de.encode(); // "Guitar solo -- File outputted"
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.
- 0.1.0 Woo
- 0.2.0 Adding switchable icon name prefixes
- 0.3.0 Adding custom selectors that allow for wildcards
Copyright (c) 2013 John Bender/Jeffrey Lembeck/Filament Group Licensed under the MIT license.