Grunt task for embedding images as base64 data URIs inside your stylesheets or as src values in other files.
JavaScript CSS
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
example
tasks
test
.gitignore
GruntFile.js
README.md
grunt-image-embed-src.sublime-project
grunt-image-embed-src.sublime-workspace
package.json

README.md

Grunt Image Embed Src

This task converts all data found within a stylesheet (those within a url( ... ) declaration) into base64-encoded data URI strings. This includes images and fonts.

Created by WillemHein Triemstra but heavily based on Eric Hynds's grunt-image-embed.

Features

  • Supports both local & remote images.
  • Ability to specify a size limit. Default is 32kb which is IE8's limit.
  • Existing data URIs will be ignored.
  • Skip specific images by specifying a directive comment (not available with option typeSrc).
  • Ability to purge images that have been encoded
  • Includes two helpers: encode_stylesheet to encode a stylesheet, and encode_image to encode an image.

Getting Started

Install this plugin with the command:

npm install grunt-image-embed-src

Next, add this line to your project's grunt file:

grunt.loadNpmTasks("grunt-image-embed-src");

Lastly, add configuration settings to your grunt.js file (see below).

Documentation

This task has two required properties, src and dest. src is the path to your stylesheet and dest is the file this task will write to (relative to the grunt.js file). If this file already exists it will be overwritten.

An example configuration looks like this:

grunt.initConfig({
  imageEmbed: {
    dist: {
      src: [ "css/styles.css" ],
      dest: "css/output.css",
      options: {
        deleteAfterEncoding : false
        typeSrc : true
      }
    }
  }
});

Optional Configuration Properties

ImageEmbed can be cust omized by specifying the following options:

  • maxImageSize: The maximum size of the base64 string in bytes. This defaults to 32768, or IE8's limit. Set this to 0 to remove the limit and allow any size string.
  • baseDir: If you have absolute image paths in your stylesheet, the path specified in this option will be used as the base directory.
  • deleteAfterEncoding: Set this to true to delete images after they've been encoded. You'll want to do this in a staging area, and not in your source directories. Be careful.
  • typeSrc: Set this to true to search (and set) 'src' declarations instead of 'url'. Example search and set image decerations like 'src=background.png' instead of (default) 'url(background)'.

Skipping Images

Specify that an image should be skipped by adding the following comment directive after the image:

background: url(image.gif); /*ImageEmbed:skip*/

Not supported when using typeSrc!

Compatibility

Version >= 0.3.0 of this plugin is compatible with Grunt 0.4.x. Versions 0.0.1 through 0.2.0 are only compatible with Grunt 0.3.x.

License

Copyright (c) 2014 WillemHein Triemstra Licensed under the MIT License.