Reads images and produces responsive CSS classes with background-imager
This plugin requires Grunt.
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:
npm install grunt-background-imager --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-background-imager');
In your project's Gruntfile, add a section named background_imager
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
background_imager: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
Type: String
Default value: null
A string value that is used to specfy URL path to image.
Type: String
Default value: null
A string value that is used to specify prefix for class names.
Type: String
Default value: "\s\s"
A string value that is used to specify whitespace used in tabbing.
Due to limitations in background-imager multi-level directory globbing is not supported. Explicit use of expand: true
is not supported either. background-imager was designed to read a directory, not files, and will not traverse subdirectories. See hparra/background-imager#10
Please use the following example:
background_imager: {
options: {
urlPath: "/images/",
classPrefix: "bg-",
tabSpacing: "\t"
},
your_target: {
files: [{
//expand: true, // DO NOT set expand true
cwd: "src/images/", // DO set cwd as intended (directory)
src: ["*.{jpg,gif,png}"],
dest: "./src/styles/background-images.css"
}]
}
}
This plugin will join cwd
with src
to check if files exist. cwd
will also be used for urlPath
unless another is specified in options
.
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. Editor Config included.
v0.0.1: initial release
Copyright (c) 2013 Hector Parra. Licensed under the MIT license.