class SassC::Script::Value::Color

A SassScript object representing a CSS color. This class provides a very bare-bones system for storing a RGB(A) or HSL(A) color and converting it to a CSS color function.

If your Sass method accepts a color you will need to perform any needed color mathematics or transformations yourself.

Attributes

alpha[R]
blue[R]
green[R]
hue[R]
lightness[R]
red[R]
saturation[R]

Public Class Methods

new(red:nil, green:nil, blue:nil, hue:nil, saturation:nil, lightness:nil, alpha:1.0) click to toggle source

Creates a new color with (‘red`, `green`, `blue`) or (`hue`, `saturation`, `lightness` values, plus an optional `alpha` transparency value.

# File lib/sassc/script/value/color.rb, line 22
def initialize(red:nil, green:nil, blue:nil, hue:nil, saturation:nil, lightness:nil, alpha:1.0)
  if red && green && blue && alpha
    @mode = :rgba
    @red = SassC::Util.clamp(red.to_i, 0, 255)
    @green = SassC::Util.clamp(green.to_i, 0, 255)
    @blue = SassC::Util.clamp(blue.to_i, 0, 255)
    @alpha = SassC::Util.clamp(alpha.to_f, 0.0, 1.0)
  elsif hue && saturation && lightness && alpha
    @mode = :hsla
    @hue = SassC::Util.clamp(hue.to_i, 0, 360)
    @saturation = SassC::Util.clamp(saturation.to_i, 0, 100)
    @lightness = SassC::Util.clamp(lightness.to_i, 0, 100)
    @alpha = SassC::Util.clamp(alpha.to_f, 0.0, 1.0)
  else
    raise SassC::UnsupportedValue, "Unable to determine color configuration for "
  end
end

Public Instance Methods

==(other_color)
Alias for: eql?
alpha_string() click to toggle source

Returns the alpha value of this color as a string and rounded to 8 decimal places.

# File lib/sassc/script/value/color.rb, line 66
def alpha_string
  alpha.round(8).to_s
end
eql?(other_color) click to toggle source

True if this Color is equal to ‘other_color`

# File lib/sassc/script/value/color.rb, line 81
def eql?(other_color)
  unless other_color.is_a?(self.class)
    raise ArgumentError, "No implicit conversion of #{other_color.class} to #{self.class}"
  end
  self.value == other_color.value
end
Also aliased as: ==
hash() click to toggle source

Returns a numeric value for comparing two Color objects This method is used internally by the Hash class and is not the same as ‘.to_h`

# File lib/sassc/script/value/color.rb, line 91
def hash
  value.hash
end
hlsa?() click to toggle source

True if this color has HSLA values

# File lib/sassc/script/value/color.rb, line 60
def hlsa?
  @mode == :hlsa
end
rgba?() click to toggle source

True if this color has RGBA values

# File lib/sassc/script/value/color.rb, line 55
def rgba?
  @mode == :rgba
end
to_s() click to toggle source

Returns a CSS color declaration in the form ‘rgb(…)`, `rgba(…)`, `hsl(…)`, or `hsla(…)`.

# File lib/sassc/script/value/color.rb, line 42
def to_s
  if rgba? && @alpha == 1.0
    return "rgb(#{@red}, #{@green}, #{@blue})"
  elsif rgba?
    return "rgba(#{@red}, #{@green}, #{@blue}, #{alpha_string})"
  elsif hsla? && @alpha == 1.0
    return "hsl(#{@hue}, #{@saturation}%, #{@lightness}%)"
  else # hsla?
    return "hsla(#{@hue}, #{@saturation}%, #{@lightness}%, #{alpha_string})"
  end
end
value() click to toggle source

Returns the values of this color in an array. Provided for compatibility between different SassC::Script::Value classes

# File lib/sassc/script/value/color.rb, line 72
def value
  return [
    red, green, blue,
    hue, saturation, lightness,
    alpha,
  ].compact
end