Returns the image and background position for use in a single shorthand property:
$icons: sprite-map("icons/*.png"); // contains icons/new.png among others. background: sprite($icons, new) no-repeat;
Becomes:
background: url('/images/icons.png?12345678') 0 -24px no-repeat;
# File lib/compass/sass_extensions/functions/sprites.rb, line 36 def sprite(map, sprite, offset_x = ZERO, offset_y = ZERO) sprite = convert_sprite_name(sprite) verify_map(map) unless sprite.is_a?(Sass::Script::String) raise Sass::SyntaxError, %(The second argument to sprite() must be a sprite name. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.) end url = sprite_url(map) position = sprite_position(map, sprite, offset_x, offset_y) Sass::Script::List.new([url] + position.value, :space) end
Returns voolean if sprite has a parent
# File lib/compass/sass_extensions/functions/sprites.rb, line 72 def sprite_does_not_have_parent(map, sprite) sprite = convert_sprite_name(sprite) verify_map map verify_sprite sprite Sass::Script::Bool.new map.image_for(sprite.value).parent.nil? end
Returns the path to the original image file for the sprite with the given name
# File lib/compass/sass_extensions/functions/sprites.rb, line 59 def sprite_file(map, sprite) sprite = convert_sprite_name(sprite) verify_map(map, "sprite") verify_sprite(sprite) if image = map.image_for(sprite.value) Sass::Script::String.new(image.relative_file) else missing_image!(map, sprite) end end
Returns boolean if sprite has the selector
# File lib/compass/sass_extensions/functions/sprites.rb, line 82 def sprite_has_selector(map, sprite, selector) sprite = convert_sprite_name(sprite) verify_map map verify_sprite sprite unless VALID_SELECTORS.include?(selector.value) raise Sass::SyntaxError, "Invalid Selctor did you mean one of: #{VALID_SELECTORS.join(', ')}" end Sass::Script::Bool.new map.send(:"has_#{selector.value}?", sprite) end
# File lib/compass/sass_extensions/functions/sprites.rb, line 149 def sprite_image(*args) raise Sass::SyntaxError, %(The sprite-image() function has been replaced by sprite(). See http://beta.compass-style.org/help/tutorials/spriting/ for more information.) end
Creates a Compass::SassExtensions::Sprites::SpriteMap object. A sprite map, when used in a property is the same as calling sprite-url. So the following background properties are equivalent:
$icons: sprite-map("icons/*.png"); background: sprite-url($icons) no-repeat; background: $icons no-repeat;
The sprite map object will generate the sprite map image, if necessary, the first time it is converted to a url. Simply constructing it has no side-effects.
# File lib/compass/sass_extensions/functions/sprites.rb, line 22 def sprite_map(glob, kwargs = {}) kwargs.extend VariableReader Compass::SassExtensions::Sprites::SpriteMap.from_uri(glob, self, kwargs) end
Returns the name of a sprite map The name is derived from the folder than contains the sprites.
# File lib/compass/sass_extensions/functions/sprites.rb, line 52 def sprite_map_name(map) verify_map(map, "sprite-map-name") Sass::Script::String.new(map.name) end
Returns the position for the original image in the sprite. This is suitable for use as a value to background-position:
$icons: sprite-map("icons/*.png"); background-position: sprite-position($icons, new);
Might generate something like:
background-position: 0 -34px;
You can adjust the background relative to this position by passing values for `$offset-x` and `$offset-y`:
$icons: sprite-map("icons/*.png"); background-position: sprite-position($icons, new, 3px, -2px);
Would change the above output to:
background-position: 3px -36px;
# File lib/compass/sass_extensions/functions/sprites.rb, line 124 def sprite_position(map, sprite = nil, offset_x = ZERO, offset_y = ZERO) sprite = convert_sprite_name(sprite) verify_map(map, "sprite-position") unless sprite && sprite.is_a?(Sass::Script::String) raise Sass::SyntaxError, %(The second argument to sprite-position must be a sprite name. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.) end image = map.image_for(sprite.value) unless image missing_image!(map, sprite) end if offset_x.unit_str == "%" x = offset_x # CE: Shouldn't this be a percentage of the total width? else x = offset_x.value - image.left x = Sass::Script::Number.new(x, x == 0 ? [] : ["px"]) end y = offset_y.value - image.top y = Sass::Script::Number.new(y, y == 0 ? [] : ["px"]) Sass::Script::List.new([x, y],:space) end
Returns a url to the sprite image.
# File lib/compass/sass_extensions/functions/sprites.rb, line 96 def sprite_url(map) verify_map(map, "sprite-url") map.generate image_url(Sass::Script::String.new("#{map.path}-s#{map.uniqueness_hash}.png"), Sass::Script::Bool.new(false), Sass::Script::Bool.new(false)) end
# File lib/compass/sass_extensions/functions/sprites.rb, line 155 def convert_sprite_name(sprite) if sprite.is_a?(Sass::Script::Color) return Sass::Script::String.new(Sass::Script::Color::HTML4_COLORS_REVERSE[sprite.rgb]) end sprite end
# File lib/compass/sass_extensions/functions/sprites.rb, line 174 def missing_image!(map, sprite) raise Sass::SyntaxError, "No sprite called #{sprite} found in sprite map #{map.path}/#{map.name}. Did you mean one of: #{map.sprite_names.join(", ")}" end
# File lib/compass/sass_extensions/functions/sprites.rb, line 178 def missing_sprite!(function_name) raise Sass::SyntaxError, %(The first argument to #{function_name}() must be a sprite map. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.) end
# File lib/compass/sass_extensions/functions/sprites.rb, line 162 def verify_map(map, error = "sprite") unless map.is_a?(Compass::SassExtensions::Sprites::SpriteMap) missing_sprite!(error) end end
# File lib/compass/sass_extensions/functions/sprites.rb, line 168 def verify_sprite(sprite) unless sprite.is_a?(Sass::Script::String) raise Sass::SyntaxError, %(The second argument to sprite() must be a sprite name. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.) end end
Generated with the Darkfish Rdoc Generator 2.