Module: Sass::Script::Functions
- Included in:
- EvaluationContext
- Defined in:
- lib/sass/script/functions.rb
Overview
Methods in this module are accessible from the SassScript context. For example, you can write
!color = hsl(120, 100%, 50%)
and it will call #hsl.
The following functions are provided:
#hsl
: Converts an hsl(hue, saturation, lightness)
triplet into a color.
#percentage : Converts a unitless number to a percentage.
#round : Rounds a number to the nearest whole number.
#ceil : Rounds a number up to the nearest whole number.
#floor : Rounds a number down to the nearest whole number.
#abs : Returns the absolute value of a number.
You can add your own functions to this module, but there are a few things to keep in mind. First of all, the arguments passed are Literal objects. Literal objects are also expected to be returned.
Second, making Ruby functions accessible from Sass introduces the temptation
to do things like database access within stylesheets.
This temptation must be resisted.
Keep in mind that Sass stylesheets are only compiled once
at a somewhat indeterminate time
and then left as static CSS files.
Any dynamic CSS should be left in <style>
tags in the HTML.
Within one of the functions in this module, methods of EvaluationContext can be used.
Defined Under Namespace
Classes: EvaluationContext
Instance Method Summary collapse
-
#abs(value) ⇒ Number
Finds the absolute value of a number.
-
#ceil(value) ⇒ Number
Rounds a number up to the nearest whole number.
-
#floor(value) ⇒ Number
Rounds down to the nearest whole number.
-
#hsl(hue, saturation, lightness) ⇒ Color
Creates a Color object from hue, saturation, and lightness as per the CSS3 spec (http://www.w3.org/TR/css3-color/#hsl-color).
-
#percentage(value) ⇒ Number
Converts a decimal number to a percentage.
-
#rgb(red, green, blue) ⇒ Object
Creates a Color object from red, green, and blue values.
-
#round(value) ⇒ Number
Rounds a number to the nearest whole number.
Instance Method Details
#abs(value) ⇒ Number
Finds the absolute value of a number. For example:
abs(10px) => 10px
abs(-10px) => 10px
172 173 174 |
# File 'lib/sass/script/functions.rb', line 172
def abs(value)
numeric_transformation(value) {|n| n.abs}
end
|
#ceil(value) ⇒ Number
Rounds a number up to the nearest whole number. For example:
ciel(10.4px) => 11px
ciel(10.6px) => 11px
146 147 148 |
# File 'lib/sass/script/functions.rb', line 146
def ceil(value)
numeric_transformation(value) {|n| n.ceil}
end
|
#floor(value) ⇒ Number
Rounds down to the nearest whole number. For example:
floor(10.4px) => 10px
floor(10.6px) => 10px
159 160 161 |
# File 'lib/sass/script/functions.rb', line 159
def floor(value)
numeric_transformation(value) {|n| n.floor}
end
|
#hsl(hue, saturation, lightness) ⇒ Color
Creates a Color object from hue, saturation, and lightness as per the CSS3 spec (http://www.w3.org/TR/css3-color/#hsl-color).
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/sass/script/functions.rb', line 90
def hsl(hue, saturation, lightness)
original_s = saturation
original_l = lightness
# This algorithm is from http://www.w3.org/TR/css3-color#hsl-color
h, s, l = [hue, saturation, lightness].map { |a| a.value }
raise ArgumentError.new("Saturation #{s} must be between 0% and 100%") if s < 0 || s > 100
raise ArgumentError.new("Lightness #{l} must be between 0% and 100%") if l < 0 || l > 100
h = (h % 360) / 360.0
s /= 100.0
l /= 100.0
m2 = l <= 0.5 ? l * (s + 1) : l + s - l * s
m1 = l * 2 - m2
Color.new([hue_to_rgb(m1, m2, h + 1.0/3),
hue_to_rgb(m1, m2, h),
hue_to_rgb(m1, m2, h - 1.0/3)].map { |c| (c * 0xff).round })
end
|
#percentage(value) ⇒ Number
Converts a decimal number to a percentage. For example:
percentage(100px / 50px) => 200%
117 118 119 120 121 122 |
# File 'lib/sass/script/functions.rb', line 117
def percentage(value)
unless value.is_a?(Sass::Script::Number) && value.unitless?
raise ArgumentError.new("#{value} is not a unitless number")
end
Sass::Script::Number.new(value.value * 100, ['%'])
end
|
#rgb(red, green, blue) ⇒ Object
Creates a Color object from red, green, and blue values.
72 73 74 75 76 77 |
# File 'lib/sass/script/functions.rb', line 72
def rgb(red, green, blue)
[red.value, green.value, blue.value].each do |v|
raise ArgumentError.new("Color value #{v} must be between 0 and 255 inclusive") if v <= 0 || v >= 255
end
Color.new([red.value, green.value, blue.value])
end
|
#round(value) ⇒ Number
Rounds a number to the nearest whole number. For example:
round(10.4px) => 10px
round(10.6px) => 11px
133 134 135 |
# File 'lib/sass/script/functions.rb', line 133
def round(value)
numeric_transformation(value) {|n| n.round}
end
|