Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
automatically css sprite
Ruby CSS

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
spec
tasks
.gitignore
MIT-LICENSE
README.textile
Rakefile
VERSION
css_sprite.gemspec

README.textile

css_sprite

automatically css sprite.


What css_sprite does?

css sprite generates css_sprite image and css files automatically for you follow the conventions as follows.

images under css_sprite directory class name in css_sprite css
twitter_icon.png .twitter_icon
facebook_icon.png .facebook_icon
hotmail-logo.png .hotmail-logo
gmail-logo.png .gmail-logo
icons/twitter_icon.png .icons .twitter_icon
widget/icons/twitter_icon.png .widget .icons .twitter_icon
twitter_icon_hover.png .twitter_icon:hover
twitter-icon-hover.png .twitter-icon:hover

css_sprite directory is the directory whose name is “css_sprite” or “css_sprite” suffixed under public/images directory.
css_sprite image is the image file automatically generated under public/images directory.
css_sprite css is the css file automatically generated under public/stylesheets directory.


Install

css_sprite depends on the rmagick gem, please make sure RMagick is successfully installed on your system.
css_sprite also depends on the optipng tool as default image optimization, but you can use any other image optimization tool, check the Configuration section. If you use the default optipng tool, please make sure it is successfully installed on your system.

install css_sprite as a gem:

sudo gem install css_sprite

or install css_sprite as a plugin:

script/plugin install git://github.com/flyerhzm/css_sprite.git


Usage

1. create a directory whose name is css_sprite or ends with css_sprite (e.g. widget_css_sprite) under public/images directory

2. if you install the css_sprite as a gem, you should add css_sprite task in Rakefile

require 'css_sprite'

If you install it as a plugin, you can skip this step

2. define config/css_sprite.yml, it is not necessary by default.

3. start css_sprite server

rake css_sprite:start

4. put any images which you need to do the css sprite under the css_sprite directory, then you will see the automatically generated css sprite image and css files.

5. include the stylesheet in your view page

<%= stylesheet_link_tag 'css_sprite' %>

You can stop the css_sprite server by rake css_sprite:stop

You can restart the css_sprite server by rake css_sprite:start

Or you can just do the css sprite manually by rake css_sprite:build


Configuration

There is no need to create any configuration by default. If you want some customizations as follows, you need to define config/css_sprite.yml file.

Sass

engine:sass

Image Optimization

css_sprite use optipng with optimization level 2 to optimize the auto generated css_sprite image. You can change it to any image optimization command.

optimization: optipng -o 7

Customization styles

  • For css
    
    suffix:
      button: |
        text-indent: -9999px;
        display: block;
        cursor: pointer;
        font-size: 0;
        line-height: 15px;
        border: 0;
        outline: 0;
      icon: |
        text-indent: -9999px;
        cursor: pointer;
    
  • For sass
    
    engine: sass
    suffix:
      button: |
        text-indent: -9999px
        display: block
        cursor: pointer
        font-size: 0
        line-height: 15px
        border: 0
        outline: 0
      icon: |
        text-indent: -9999px
        cursor: pointer
    

engine defines css (default) or sass file to generate.
suffix defines the customization styles for specified images.
The customization above means if your image filename is button suffixed (e.g. post_button.png), the corresponding class .post_button has the additional style with (outline: 0; border: 0; and so on),
if your image filename is icon suffixed (e.g. twitter_icon.png), the correspondiing class .twitter_icon has the additional style with (text-indent: -9999px; cursor: pointer)


Best Practices

I have written posts “css sprite best practices” to introduce the idea that the css_sprite gem follows.
english version
chinese version


Copyright © 2009 [Richard Huang (flyerhzm@gmail.com)], released under the MIT license

Something went wrong with that request. Please try again.