grunt-image-sprite

convert images to a css sprite image

Getting Started

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-image-sprite --save-dev

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

grunt.loadNpmTasks('grunt-image-sprite');

More about instalation

The plugin depend on imagemagick. ImageMagick is a software suite to create, edit, compose, or convert bitmap images. You can goto http://www.imagemagick.org/ for details.

If your os is Ubuntu|Mac os, when you run npm install grunt-image-sprite, script will automatically install imagemagick.

If you use windows and other os, or the instalation failed, please install imagemagick manually. Goto http://www.imagemagick.org/script/binary-releases.php for details.

The "image_sprite" task

Overview

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

grunt.initConfig({
  image_sprite: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.retina

Type: Boolean|Function Default value: false

A value that is used to enable/disable retina feature.

If setted to true, when iterating all images, the image whose path is like name@2x.ext or dir@2x/name.ext will be taked as the retina image.

If setted to a function, the image path will be passed to the function as argument and the function should return a boolean value. Then, if the returned value is true, the plugin will take the image as retina image.

options.vertical

Type: Boolean Default value: true

A boolean value that is used to specify orientation of icons.

options.margin

Type: Number Default value: 0

A number value that is used to specify margin(icon's gap).

options.prefix

Type: String Default value: 'icon'

A string value that is used as class name's prefix when generate css file.

.icon-angle-down-suffix {
// 'icon' is the prefix, '-' is the connector, 'andle-down' is automatically generated from file's name, 'suffix' is the suffix.
}

options.connector

Type: String Default value: '-'

A string value that is used as connector when generate css file.

options.suffix

Type: String Default value: ''

A string value that is used as class name's suffix when generate css file.

options.cssPath

Type: String Default value: ''

A string value that is used to specify css file's path

options.cssFile

Type: String|Function Default value: ''

A string/function value that is used to specify css file's name. If it is set to function, the generated sprite image's path will be passed as argument.

Usage Examples

Default Options

Run command grunt image_sprite, you will get the tmp/sprite.png and tmp/sprite.css.

grunt.initConfig({
  image_sprite: {
    options: {
      'cssPath': 'tmp',
      'vertical': true,
      'margin': 2
    },
    sprite: {
      options: {
        'vertical': true,
        'cssFile': 'sprite.css' // 'sprite.less' is also allowed
      },
      files: {
        'tmp/sprite.png': ['test/fixtures/*.png']
      }
    }
  },
})

How to use the generated sprite style inside your project?

If you use v0.0.1, you need some more work:

1. add css/less code bellow:

   @import url('tmp/sprite.css');
   
   .icon {
     display: inline-block; // block;
     background-image: url('tmp/sprite.png');
     background-repeat: no-repeat;
   }

2. make sure css/less file path and sprite image path are right. Include css file in your html.

3. Finally you can write something like this:

   <i class='icon icon-angle-down'></i>

Otherwise(from v0.1.0), you can just include the generated style file and write <i class='icon icon-angle-down'></i>.

Contributing

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.

Release History

2015-06-02    v0.1.1    fix bug when images not found.

2015-05-07    v0.1.0    support retina and enhance style file.

2015-04-17    v0.0.1    init

License

Copyright (c) 2015 creeperyang. Licensed under the MIT license.