This module provides an API to consolidate images into a single sprite image.
When an image hits the sprite registry, it will be entered into a static array. At the end of a page load, all so entered images will be consolidated into a single image made up of them all, and a CSS file will be generated to properly display the image. The registry array will be saved to the cache with its md5 hash, so that future sprite images of the same composition may be retrieved without rebuilding that image.
Two related projects, CSS Sprites and CSS Sprite Generator, work with themes, and purport to work on the theme level, replacing theme css files with the sprite files. This is meant to work in conjuction with that, but using page generated images, such as image fields. In the future, as this module simply provides an API, they may work together, ultimately creating one single image and CSS file for all images and CSS background images on a page. For now, you could, in theory, use the two modules together to create no more than two image files for a single page.
How to use the sprite module:
* theme("sprite", $filepath, $alt = "", $title = NULL, $attributes = array(), $registry = "general", $override_width = NULL, $override_height = NULL, $offset_width = NULL, $offset_height = NULL)
* "Sprite HTML" image formatting option in views and in the content type display fields config page
* " sprite" image formatting option in views and in the content type display fields config page
* sprite_register($filepath = NULL, $registry = "general", $override_width = NULL, $override_height = NULL, $offset_width = NULL, $offset_height = NULL)
Note: the 'registry' parameter allows you to specify a different sprite file for your image. Ex. You can use 'navigation' to assign all your nav images to one sprite and then use 'right' for all the small images that appear in the right rail.
- Maintenance status: Actively maintained
- Development status: Under active development
- Module categories: Content Display, File Management, Media, Theme Enhancements, Utility
- Reported installs: 2 sites currently report using this module. View usage statistics.
- Downloads: 692
- Last modified: November 27, 2014
- Stable releases are covered by the security advisory policy.
Look for the shield icon below.