sass:color
- Dart Sass
- since 1.23.0
- LibSass
- ✗
- Ruby Sass
- ✗
Only Dart Sass currently supports loading built-in modules with @use
. Users
of other implementations must call functions using their global names instead.
color.adjust($color,
$red: null, $green: null, $blue: null,
$hue: null, $saturation: null, $lightness: null,
$whiteness: null, $blackness: null,
$x: null, $y: null, $z: null,
$chroma: null,
$alpha: null,
$space: null)
adjust-color(...) //=> color
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
- Dart Sass
- since 1.28.0
- LibSass
- ✗
- Ruby Sass
- ✗
Increases or decreases one or more channels of $color
by fixed amounts.
Adds the value passed for each keyword argument to the corresponding channel
of the color, and returns the adjusted color. By default, this can only adjust
channels in $color
’s space, but a different color space can be passed as
$space
to adjust channels there instead. This always returns a color in the
same space as $color
.
⚠️ Heads up!
For historical reasons, if $color
is in a legacy color space, any
legacy color space channels can be adjusted. However, it’s an error to
specify an RGB channel ($red
, $green
, and/or $blue
) at the same time
as an HSL channel ($hue
, $saturation
, and/or $lightness
), or either of
those at the same time as an HWB channel ($hue
, $whiteness
, and/or
$blackness
).
Even so, it’s a good idea to pass $space
explicitly even for legacy colors.
All channel arguments must be numbers, and must be units that could be passed for those channels in the color space’s constructor. If the existing channel value plus the adjustment value is outside the channel’s native range, it’s clamped for:
- red, green, and blue channels for the
rgb
space; - lightness channel for the
lab
,lch
,oklab
, andoklch
spaces; - the lower bound of the saturation and chroma channels for the
hsl
,lch
, andoklch
spaces; - and the alpha channel for all spaces.
See also:
color.scale()
for fluidly scaling a color’s properties.color.change()
for setting a color’s properties.
SCSS Syntax
@use 'sass:color';
@debug color.adjust(#6b717f, $red: 15); // #7a717f
@debug color.adjust(lab(40% 30 40), $lightness: 10%, $a: -20); // lab(50% 10 40)
@debug color.adjust(#d2e1dd, $hue: 45deg, $space: oklch);
// rgb(209.7987626149, 223.8632000471, 229.3988769575)
Sass Syntax
@use 'sass:color'
@debug color.adjust(#6b717f, $red: 15) // #7a717f
@debug color.adjust(lab(40% 30 40), $lightness: 10%, $a: -20) // lab(50% 10 40)
@debug color.adjust(#d2e1dd, $hue: 45deg, $space: oklch)
// rgb(209.7987626149, 223.8632000471, 229.3988769575)
color.change($color,
$red: null, $green: null, $blue: null,
$hue: null, $saturation: null, $lightness: null,
$whiteness: null, $blackness: null,
$x: null, $y: null, $z: null,
$chroma: null,
$alpha: null,
$space: null)
change-color(...) //=> color
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
- Dart Sass
- since 1.28.0
- LibSass
- ✗
- Ruby Sass
- ✗
Sets one or more channels of a color to new values.
Uses the value passed for each keyword argument in place of the corresponding
color channel, and returns the changed color. By default, this can only change
channels in $color
’s space, but a different color space can be passed as
$space
to adjust channels there instead. This always returns a color in the
same space as $color
.
⚠️ Heads up!
For historical reasons, if $color
is in a legacy color space, any
legacy color space channels can be changed. However, it’s an error to
specify an RGB channel ($red
, $green
, and/or $blue
) at the same time
as an HSL channel ($hue
, $saturation
, and/or $lightness
), or either
of those at the same time as an HWB channel ($hue
, $whiteness
, and/or
$blackness
).
Even so, it’s a good idea to pass $space
explicitly even for legacy colors.
All channel arguments must be numbers, and must be units that could be passed
for those channels in the color space’s constructor. Channels are never
clamped for color.change()
.
See also:
color.scale()
for fluidly scaling a color’s properties.color.adjust()
for adjusting a color’s properties by fixed amounts.
SCSS Syntax
@use 'sass:color';
@debug color.change(#6b717f, $red: 100); // #64717f
@debug color.change(color(srgb 0 0.2 0.4), $red: 0.8, $blue: 0.1);
// color(srgb 0.8 0.1 0.4)
@debug color.change(#998099, $lightness: 30%, $space: oklch);
// rgb(58.0719961509, 37.2631531594, 58.4201613409)
Sass Syntax
@use 'sass:color'
@debug color.change(#6b717f, $red: 100) // #64717f
@debug color.change(color(srgb 0 0.2 0.4), $red: 0.8, $blue: 0.1)
// color(srgb 0.8 0.1 0.4)
@debug color.change(#998099, $lightness: 30%, $space: oklch)
// rgb(58.0719961509, 37.2631531594, 58.4201613409)
color.channel($color, $channel, $space: null) //=> number
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns the value of $channel
in $space
, which defaults to $color
’s
space. The $channel
must be a quoted string, and the $space
must be an
unquoted string.
This returns a number with unit deg
for the hue
channel of the hsl
,
hwb
, lch
, and oklch
spaces. It returns a number with unit %
for the
saturation
, lightness
, whiteness
, and blackness
channels of the hsl
,
hwb
, lab
, lch
, oklab
, and oklch
spaces. For all other channels, it
returns a unitless number.
This will return 0
(possibly with an appropriate unit) if the $channel
is
missing in $color
. You can use color.is-missing()
to check explicitly
for missing channels.
SCSS Syntax
@use 'sass:color';
@debug color.channel(hsl(80deg 30% 50%), "hue"); // 80deg
@debug color.channel(hsl(80deg 30% 50%), "hue", $space: oklch); // 124.279238779deg
@debug color.channel(hsl(80deg 30% 50%), "red", $space: rgb); // 140.25
Sass Syntax
@use 'sass:color'
@debug color.channel(hsl(80deg 30% 50%), "hue") // 80deg
@debug color.channel(hsl(80deg 30% 50%), "hue", $space: oklch) // 124.279238779deg
@debug color.channel(hsl(80deg 30% 50%), "red", $space: rgb) // 140.25
color.complement($color, $space: null)
complement($color, $space: null) //=> color
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns the complement of $color
in $space
.
This rotates $color
’s hue by 180deg
in $space
. This means that $space
has to be a polar color space: hsl
, hwb
, lch
, or oklch
. It always
returns a color in the same space as $color
.
⚠️ Heads up!
For historical reasons, $space
is optional if $color
is in a legacy
color space. In that case, $space
defaults to hsl
. It’s always a good
idea to pass $space
explicitly regardless.
SCSS Syntax
@use 'sass:color';
// HSL hue 222deg becomes 42deg.
@debug color.complement(#6b717f); // #7f796b
// Oklch hue 267.1262408996deg becomes 87.1262408996deg
@debug color.complement(#6b717f, oklch);
// rgb(118.8110604298, 112.5123650034, 98.1616586336)
// Hue 70deg becomes 250deg.
@debug color.complement(oklch(50% 0.12 70deg), oklch); // oklch(50% 0.12 250deg)
Sass Syntax
@use 'sass:color'
// HSL hue 222deg becomes 42deg.
@debug color.complement(#6b717f) // #7f796b
// Oklch hue 267.1262408996deg becomes 87.1262408996deg
@debug color.complement(#6b717f, oklch)
// rgb(118.8110604298, 112.5123650034, 98.1616586336)
// Hue 70deg becomes 250deg.
@debug color.complement(oklch(50% 0.12 70deg), oklch) // oklch(50% 0.12 250deg)
color.grayscale($color)
grayscale($color) //=> color
Returns a gray color with the same lightness as $color
.
If $color
is in a legacy color space, this sets the HSL saturation to 0%.
Otherwise, it sets the Oklch chroma to 0%.
SCSS Syntax
@use 'sass:color';
@debug color.grayscale(#6b717f); // #757575
@debug color.grayscale(color(srgb 0.4 0.2 0.6)); // color(srgb 0.3233585271 0.3233585411 0.3233585792)
@debug color.grayscale(oklch(50% 80% 270deg)); // oklch(50% 0% 270deg)
Sass Syntax
@use 'sass:color'
@debug color.grayscale(#6b717f) // #757575
@debug color.grayscale(color(srgb 0.4 0.2 0.6)) // color(srgb 0.3233585271 0.3233585411 0.3233585792)
@debug color.grayscale(oklch(50% 80% 270deg)) // oklch(50% 0% 270deg)
color.ie-hex-str($color)
ie-hex-str($color) //=> unquoted string
Returns an unquoted string that represents $color
in the #AARRGGBB
format
expected by Internet Explorer’s -ms-filter
property.
If $color
isn’t already in the rgb
color space, it’s converted to rgb
and gamut-mapped if necessary. The specific gamut-mapping algorithm may change
in future Sass versions as the state of the art improves; currently,
local-minde
is used.
SCSS Syntax
@use 'sass:color';
@debug color.ie-hex-str(#b37399); // #FFB37399
@debug color.ie-hex-str(rgba(242, 236, 228, 0.6)); // #99F2ECE4
@debug color.ie-hex-str(oklch(70% 10% 120deg)); // #FF9BA287
Sass Syntax
@use 'sass:color'
@debug color.ie-hex-str(#b37399) // #FFB37399
@debug color.ie-hex-str(rgba(242, 236, 228, 0.6)) // #99F2ECE4
@debug color.ie-hex-str(oklch(70% 10% 120deg)) // #FF9BA287
color.invert($color, $weight: 100%, $space: null)
invert($color, $weight: 100%, $space: null) //=> color
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns the inverse or negative of $color
in $space
.
The $weight
must be a number between 0%
and 100%
(inclusive). A higher
weight means the result will be closer to the negative, and a lower weight
means it will be closer to $color
. Weight 50%
will always produce a
medium-lightness gray in $space
.
⚠️ Heads up!
For historical reasons, $space
is optional if $color
is in a legacy
color space. In that case, $space
defaults to $color
’s own space. It’s
always a good idea to pass $space
explicitly regardless.
SCSS Syntax
@use 'sass:color';
@debug color.invert(#b37399, $space: rgb); // #4c8c66
@debug color.invert(#550e0c, 20%, $space: display-p3); // rgb(103.4937692017, 61.3720912206, 59.430641338)
Sass Syntax
@use 'sass:color';
@debug color.invert(#b37399, $space: rgb) // #4c8c66
@debug color.invert(#550e0c, 20%, $space: display-p3) // rgb(103.4937692017, 61.3720912206, 59.430641338)
color.is-legacy($color) //=> boolean
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns whether $color
is in a legacy color space.
SCSS Syntax
@use 'sass:color';
@debug color.is-legacy(#b37399); // true
@debug color.is-legacy(hsl(90deg 30% 90%)); // true
@debug color.is-legacy(oklch(70% 10% 120deg)); // false
Sass Syntax
@use 'sass:color'
@debug color.is-legacy(#b37399) // true
@debug color.is-legacy(hsl(90deg 30% 90%)) // true
@debug color.is-legacy(oklch(70% 10% 120deg)) // false
color.is-missing($color, $channel) //=> boolean
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns whether $channel
is [missing] in $color
. The $channel
must be a
quoted string.
SCSS Syntax
@use 'sass:color';
@debug color.is-missing(#b37399, "green"); // false
@debug color.is-missing(rgb(100 none 200), "green"); // true
@debug color.is-missing(color.to-space(grey, lch), "hue"); // true
Sass Syntax
@use 'sass:color'
@debug color.is-legacy(#b37399) // true
@debug color.is-legacy(hsl(90deg 30% 90%)) // true
@debug color.is-legacy(oklch(70% 10% 120deg)) // false
color.is-powerless($color, $channel, $space: null) //=> boolean
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns whether $color
’s $channel
is powerless in $space
, which
defaults to $color
’s space. The $channel
must be a quoted string and the
$space
must be an unquoted string.
Channels are considered powerless in the following circumstances:
- In the
hsl
space, thehue
is powerless if thesaturation
is 0%. - In the
hwb
space, thehue
is powerless if thewhiteness
plus theblackness
is greater than 100%. - In the
lch
andoklch
spaces, thehue
is powerless if thechroma
is 0%.
SCSS Syntax
@use 'sass:color';
@debug color.is-powerless(hsl(180deg 0% 40%), "hue"); // true
@debug color.is-powerless(hsl(180deg 0% 40%), "saturation"); // false
@debug color.is-powerless(#999, "hue", $space: hsl); // true
Sass Syntax
@use 'sass:color'
@debug color.is-powerless(hsl(180deg 0% 40%), "hue") // true
@debug color.is-powerless(hsl(180deg 0% 40%), "saturation") // false
@debug color.is-powerless(#999, "hue", $space: hsl) // true
color.mix($color1, $color2, $weight: 50%, $method: null)
mix($color1, $color2, $weight: 50%, $method: null) //=> color
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns a color that’s a mixture of $color1
and $color2
using $method
,
which is the name of a color space, optionally followed by a hue
interpolation method if it’s a polar color space (hsl
, hwb
, lch
, or
oklch
).
This uses the same algorithm to mix colors as the CSS color-mix()
function. This also means that if either color has a missing channel in the
interpolation space, it will take on the corresponding channel value from the
other color. This always returns a color in $color1
’s space.
The $weight
must be a number between 0%
and 100%
(inclusive). A larger
weight indicates that more of $color1
should be used, and a smaller weight
indicates that more of $color2
should be used.
⚠️ Heads up!
For historical reasons, $method
is optional if $color1
and $color2
are
both in legacy color spaces. In this case, color mixing is done using the
same algorithm that Sass used historically, in which both the $weight
and
the relative opacity of each color determines how much of each color is in
the result.
SCSS Syntax
@use 'sass:color';
@debug color.mix(#036, #d2e1dd, $method: rgb); // #698aa2
@debug color.mix(#036, #d2e1dd, $method: oklch); // rgb(87.864037264, 140.601918773, 154.2876826946)
@debug color.mix(
color(rec2020 1 0.7 0.1),
color(rec2020 0.8 none 0.3),
$weight: 75%,
$method: rec2020
); // color(rec2020 0.95 0.7 0.15)
@debug color.mix(
oklch(80% 20% 0deg),
oklch(50% 10% 120deg),
$method: oklch longer hue
); // oklch(65% 0.06 240deg)
Sass Syntax
@use 'sass:color';
@debug color.mix(#036, #d2e1dd, $method: rgb) // #698aa2
@debug color.mix(#036, #d2e1dd, $method: oklch) // rgb(87.864037264, 140.601918773, 154.2876826946)
@debug color.mix(color(rec2020 1 0.7 0.1), color(rec2020 0.8 none 0.3), $weight: 75%, $method: rec2020) // color(rec2020 0.95 0.7 0.15)
@debug color.mix(oklch(80% 20% 0deg), oklch(50% 10% 120deg), $method: oklch longer hue) // oklch(65% 0.06 240deg)
color.same($color1, $color2) //=> boolean
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns whether $color1
and $color2
visually render as the same color.
Unlike ==
, this considers colors to be equivalent even if they’re in
different color spaces as long as they represent the same color value in the
xyz
color space. This treats missing channels as equivalent to zero.
SCSS Syntax
@use 'sass:color';
@debug color.same(#036, #036); // true
@debug color.same(#036, #037); // false
@debug color.same(#036, color.to-space(#036, oklch)); // true
@debug color.same(hsl(none 50% 50%), hsl(0deg 50% 50%)); // true
Sass Syntax
@use 'sass:color'
@debug color.same(#036, #036) // true
@debug color.same(#036, #037) // false
@debug color.same(#036, color.to-space(#036, oklch)) // true
@debug color.same(hsl(none 50% 50%), hsl(0deg 50% 50%)) // true
color.scale($color,
$red: null, $green: null, $blue: null,
$saturation: null, $lightness: null,
$whiteness: null, $blackness: null,
$x: null, $y: null, $z: null,
$chroma: null,
$alpha: null,
$space: null)
scale-color(...) //=> color
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
- Dart Sass
- since 1.28.0
- LibSass
- ✗
- Ruby Sass
- ✗
Fluidly scales one or more properties of $color
.
Each keyword argument must be a number between -100%
and 100%
(inclusive).
This indicates how far the corresponding property should be moved from its
original position towards the maximum (if the argument is positive) or the
minimum (if the argument is negative). This means that, for example,
$lightness: 50%
will make all colors 50%
closer to maximum lightness
without making them fully white. By default, this can only scale colors in
$color
’s space, but a different color space can be passed as $space
to
scale channels there instead. This always returns a color in the same space as
$color
.
⚠️ Heads up!
For historical reasons, if $color
is in a legacy color space, any
legacy color space channels can be scaled. However, it’s an error to specify
an RGB channel ($red
, $green
, and/or $blue
) at the same time as an HSL
channel ($saturation
, and/or $lightness
), or either of those at the same
time as an HWB channel ($hue
, $whiteness
, and/or $blackness
).
Even so, it’s a good idea to pass $space
explicitly even for legacy colors.
See also:
color.adjust()
for changing a color’s properties by fixed amounts.color.change()
for setting a color’s properties.
SCSS Syntax
@use 'sass:color';
@debug color.scale(#6b717f, $red: 15%); // rgb(129.2, 113, 127)
@debug color.scale(#d2e1dd, $lightness: -10%, $space: oklch);
// rgb(181.2580722731, 195.8949200496, 192.0059024063)
@debug color.scale(oklch(80% 20% 120deg), $chroma: 50%, $alpha: -40%);
// oklch(80% 0.24 120deg / 0.6)
Sass Syntax
@use 'sass:color'
@debug color.scale(#6b717f, $red: 15%) // rgb(129.2, 113, 127)
@debug color.scale(#d2e1dd, $lightness: -10%, $space: oklch)
// rgb(181.2580722731, 195.8949200496, 192.0059024063)
@debug color.scale(oklch(80% 20% 120deg), $chroma: 50%, $alpha: -40%)
// oklch(80% 0.24 120deg / 0.6)
color.space($color) //=> unquoted string
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns the name of $color
’s space as an unquoted string.
SCSS Syntax
@use 'sass:color';
@debug color.space(#036); // rgb
@debug color.space(hsl(120deg 40% 50%)); // hsl
@debug color.space(color(xyz-d65 0.1 0.2 0.3)); // xyz
Sass Syntax
@use 'sass:color'
@debug color.space(#036) // rgb
@debug color.space(hsl(120deg 40% 50%)) // hsl
@debug color.space(color(xyz-d65 0.1 0.2 0.3)) // xyz
color.to-gamut($color, $space: null, $method: null) //=> color
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns a visually similar color to $color
in the gamut of $space
, which
defaults to $color
’s space. If $color
is already in-gamut for $space
,
it’s returned as-is. This always returns a color in $color
’s original space.
The $space
must be an unquoted string.
The $method
indicates how Sass should choose a "similar" color:
-
local-minde
: This is the method currently recommended by the CSS Colors 4 specification. It binary searches the Oklch chroma space of the color until it finds a color whose clipped-to-gamut value is as close as possible to the reduced-chroma variant. -
clip
: This simply clips all channels to within$space
’s gamut, setting them to the minimum or maximum gamut values if they’re out-of-gamut.
⚠️ Heads up!
The CSS working group and browser vendors are still actively discussing
alternative options for a recommended gamut-mapping algorithm. Until they
settle on a recommendation, the $method
parameter is mandatory in
color.to-gamut()
so that we can eventually make its default value the same
as the CSS default.
SCSS Syntax
@use 'sass:color';
@debug color.to-gamut(#036, $method: local-minde); // #036
@debug color.to-gamut(oklch(60% 70% 20deg), $space: rgb, $method: local-minde);
// oklch(61.2058838235% 0.2466052584 22.0773325274deg)
@debug color.to-gamut(oklch(60% 70% 20deg), $space: rgb, $method: clip);
// oklch(62.5026609544% 0.2528579741 24.1000466758deg)
Sass Syntax
@use 'sass:color'
@debug color.to-gamut(#036, $method: local-minde) // #036
@debug color.to-gamut(oklch(60% 70% 20deg), $space: rgb, $method: local-minde)
// oklch(61.2058838235% 0.2466052584 22.0773325274deg)
@debug color.to-gamut(oklch(60% 70% 20deg), $space: rgb, $method: clip)
// oklch(62.5026609544% 0.2528579741 24.1000466758deg)
color.to-space($color, $space) //=> color
- Dart Sass
- since 1.78.0
- LibSass
- ✗
- Ruby Sass
- ✗
Converts $color
into the given $space
, which must be an unquoted string.
If the gamut of $color
’s original space is wider than $space
’s gamut, this
may return a color that’s out-of-gamut for the $space
. You can convert it to
a similar in-gamut color using color.to-gamut()
.
This can produce colors with missing channels, either if $color
has an
analogous channel that’s missing, or if the channel is powerless in the
destination space. In order to ensure that converting to legacy color spaces
always produces a color that’s compatible with older browsers, if $space
is
legacy this will never return a new missing channel.
💡 Fun fact:
This is the only Sass function that returns a color in a different space than the one passed in.
SCSS Syntax
@use 'sass:color';
@debug color.to-space(#036, display-p3); // lch(20.7457453073% 35.0389733355 273.0881809283deg)
@debug color.to-space(oklab(44% 0.09 -0.13)); // rgb(103.1328911972, 50.9728091281, 150.8382311692)
@debug color.to-space(xyz(0.8 0.1 0.1)); // color(a98-rgb 1.2177586808 -0.7828263424 0.3516847577)
@debug color.to-space(grey, lch); // lch(53.5850134522% 0 none)
@debug color.to-space(lch(none 10% 30deg), oklch); // oklch(none 0.3782382429 11.1889160032deg)
Sass Syntax
@use 'sass:color'
@debug color.to-space(#036, display-p3) // lch(20.7457453073% 35.0389733355 273.0881809283deg)
@debug color.to-space(oklab(44% 0.09 -0.13)) // rgb(103.1328911972, 50.9728091281, 150.8382311692)
@debug color.to-space(xyz(0.8 0.1 0.1)) // color(a98-rgb 1.2177586808 -0.7828263424 0.3516847577)
@debug color.to-space(grey, lch) // lch(53.5850134522% 0 none)
@debug color.to-space(lch(none 10% 30deg), oklch) // oklch(none 0.3782382429 11.1889160032deg)
Deprecated FunctionsDeprecated Functions permalink
adjust-hue($color, $degrees) //=> color
Increases or decreases $color
’s HSL hue.
The $hue
must be a number between -360deg
and 360deg
(inclusive) to add
to $color
’s hue. It may be unitless or have any angle unit. The $color
must be in a legacy color space.
See also color.adjust()
, which can adjust any property of a color.
⚠️ Heads up!
Because adjust-hue()
is redundant with color.adjust()
, it’s not
included directly in the new module system. Instead of adjust-hue($color, $amount)
, you can write color.adjust($color, $hue: $amount, $space: hsl)
.
SCSS Syntax
// Hue 222deg becomes 282deg.
@debug adjust-hue(#6b717f, 60deg); // #796b7f
// Hue 164deg becomes 104deg.
@debug adjust-hue(#d2e1dd, -60deg); // #d6e1d2
// Hue 210deg becomes 255deg.
@debug adjust-hue(#036, 45); // #1a0066
Sass Syntax
// Hue 222deg becomes 282deg.
@debug adjust-hue(#6b717f, 60deg) // #796b7f
// Hue 164deg becomes 104deg.
@debug adjust-hue(#d2e1dd, -60deg) // #d6e1d2
// Hue 210deg becomes 255deg.
@debug adjust-hue(#036, 45) // #1a0066
color.alpha($color)
alpha($color)
opacity($color) //=> number
Returns the alpha channel of $color
as a number between 0 and 1.
The $color
must be in a legacy color space.
As a special case, this supports the Internet Explorer syntax
alpha(opacity=20)
, for which it returns an unquoted string.
⚠️ Heads up!
Because color.alpha()
is redundant with color.channel()
,
it’s no longer recommended. Instead of color.alpha($color)
, you can write
color.channel($color, "alpha")
.
SCSS Syntax
@use 'sass:color';
@debug color.alpha(#e1d7d2); // 1
@debug color.opacity(rgb(210, 225, 221, 0.4)); // 0.4
@debug alpha(opacity=20); // alpha(opacity=20)
Sass Syntax
@use 'sass:color'
@debug color.alpha(#e1d7d2) // 1
@debug color.opacity(rgb(210, 225, 221, 0.4)) // 0.4
@debug alpha(opacity=20) // alpha(opacity=20)
color.blackness($color)
blackness($color) //=> number
- Dart Sass
- since 1.28.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns the HWB blackness of $color
as a number between 0%
and 100%
.
The $color
must be in a legacy color space.
⚠️ Heads up!
Because color.blackness()
is redundant with color.channel()
,
it’s no longer recommended. Instead of color.blackness($color)
, you can
write color.channel($color, "blackness")
.
SCSS Syntax
@use 'sass:color';
@debug color.blackness(#e1d7d2); // 11.7647058824%
@debug color.blackness(white); // 0%
@debug color.blackness(black); // 100%
Sass Syntax
@use 'sass:color'
@debug color.blackness(#e1d7d2) // 11.7647058824%
@debug color.blackness(white) // 0%
@debug color.blackness(black) // 100%
color.blue($color)
blue($color) //=> number
Returns the blue channel of $color
as a number between 0 and 255.
The $color
must be in a legacy color space.
⚠️ Heads up!
Because color.blue()
is redundant with color.channel()
, it’s
no longer recommended. Instead of color.blue($color)
, you can write
color.channel($color, "blue")
.
SCSS Syntax
@use 'sass:color';
@debug color.blue(#e1d7d2); // 210
@debug color.blue(white); // 255
@debug color.blue(black); // 0
Sass Syntax
@use 'sass:color'
@debug color.blue(#e1d7d2) // 210
@debug color.blue(white) // 255
@debug color.blue(black) // 0
darken($color, $amount) //=> color
Makes $color
darker.
The $color
must be in a legacy color space.
The $amount
must be a number between 0%
and 100%
(inclusive). Decreases
the HSL lightness of $color
by that amount.
⚠️ Heads up!
The darken()
function decreases lightness by a fixed amount, which is
often not the desired effect. To make a color a certain percentage darker
than it was before, use color.scale()
instead.
Because darken()
is usually not the best way to make a color darker, it’s
not included directly in the new module system. However, if you have to
preserve the existing behavior, darken($color, $amount)
can be written
color.adjust($color, $lightness: -$amount, $space: hsl)
.
SCSS Syntax
@use 'sass:color';
// #036 has lightness 20%, so when darken() subtracts 30% it just returns black.
@debug darken(#036, 30%); // black
// scale() instead makes it 30% darker than it was originally.
@debug color.scale(#036, $lightness: -30%); // #002447
Sass Syntax
@use 'sass:color'
// #036 has lightness 20%, so when darken() subtracts 30% it just returns black.
@debug darken(#036, 30%) // black
// scale() instead makes it 30% darker than it was originally.
@debug color.scale(#036, $lightness: -30%) // #002447
SCSS Syntax
// Lightness 92% becomes 72%.
@debug darken(#b37399, 20%); // #7c4465
// Lightness 85% becomes 45%.
@debug darken(#f2ece4, 40%); // #b08b5a
// Lightness 20% becomes 0%.
@debug darken(#036, 30%); // black
Sass Syntax
// Lightness 92% becomes 72%.
@debug darken(#b37399, 20%) // #7c4465
// Lightness 85% becomes 45%.
@debug darken(#f2ece4, 40%) // #b08b5a
// Lightness 20% becomes 0%.
@debug darken(#036, 30%) // black
desaturate($color, $amount) //=> color
Makes $color
less saturated.
The $color
must be in a legacy color space.
The $amount
must be a number between 0%
and 100%
(inclusive). Decreases
the HSL saturation of $color
by that amount.
⚠️ Heads up!
The desaturate()
function decreases saturation by a fixed amount, which is
often not the desired effect. To make a color a certain percentage less
saturated than it was before, use color.scale()
instead.
Because desaturate()
is usually not the best way to make a color less
saturated, it’s not included directly in the new module system. However, if
you have to preserve the existing behavior, desaturate($color, $amount)
can be written color.adjust($color, $saturation: -$amount, $space: hsl)
.
SCSS Syntax
@use 'sass:color';
// #d2e1dd has saturation 20%, so when desaturate() subtracts 30% it just
// returns gray.
@debug desaturate(#d2e1dd, 30%); // #dadada
// scale() instead makes it 30% less saturated than it was originally.
@debug color.scale(#6b717f, $saturation: -30%); // #6e727c
Sass Syntax
@use 'sass:color'
// #6b717f has saturation 20%, so when desaturate() subtracts 30% it just
// returns gray.
@debug desaturate(#d2e1dd, 30%) // #dadada
// scale() instead makes it 30% less saturated than it was originally.
@debug color.scale(#6b717f, $saturation: -30%) // #6e727c
SCSS Syntax
// Saturation 100% becomes 80%.
@debug desaturate(#036, 20%); // #0a335c
// Saturation 35% becomes 15%.
@debug desaturate(#f2ece4, 20%); // #eeebe8
// Saturation 20% becomes 0%.
@debug desaturate(#d2e1dd, 30%); // #dadada
Sass Syntax
// Saturation 100% becomes 80%.
@debug desaturate(#036, 20%) // #0a335c
// Saturation 35% becomes 15%.
@debug desaturate(#f2ece4, 20%) // #eeebe8
// Saturation 20% becomes 0%.
@debug desaturate(#d2e1dd, 30%) // #dadada
color.green($color)
green($color) //=> number
Returns the green channel of $color
as a number between 0 and 255.
The $color
must be in a legacy color space.
⚠️ Heads up!
Because color.green()
is redundant with color.channel()
,
it’s no longer recommended. Instead of color.green($color)
, you can write
color.channel($color, "green")
.
SCSS Syntax
@use 'sass:color';
@debug color.green(#e1d7d2); // 215
@debug color.green(white); // 255
@debug color.green(black); // 0
Sass Syntax
@use 'sass:color'
@debug color.green(#e1d7d2) // 215
@debug color.green(white) // 255
@debug color.green(black) // 0
color.hue($color)
hue($color) //=> number
Returns the hue of $color
as a number between 0deg
and 360deg
.
The $color
must be in a legacy color space.
⚠️ Heads up!
Because color.hue()
is redundant with color.channel()
, it’s
no longer recommended. Instead of color.hue($color)
, you can write
color.channel($color, "hue")
.
SCSS Syntax
@use 'sass:color';
@debug color.hue(#e1d7d2); // 20deg
@debug color.hue(#f2ece4); // 34.2857142857deg
@debug color.hue(#dadbdf); // 228deg
Sass Syntax
@use 'sass:color'
@debug color.hue(#e1d7d2) // 20deg
@debug color.hue(#f2ece4) // 34.2857142857deg
@debug color.hue(#dadbdf) // 228deg
lighten($color, $amount) //=> color
Makes $color
lighter.
The $color
must be in a legacy color space.
The $amount
must be a number between 0%
and 100%
(inclusive). Increases
the HSL lightness of $color
by that amount.
⚠️ Heads up!
The lighten()
function increases lightness by a fixed amount, which is
often not the desired effect. To make a color a certain percentage lighter
than it was before, use scale()
instead.
Because lighten()
is usually not the best way to make a color lighter,
it’s not included directly in the new module system. However, if you have to
preserve the existing behavior, lighten($color, $amount)
can be written
color.adjust($color, $lightness: $amount, $space: hsl)
.
SCSS Syntax
@use 'sass:color';
// #e1d7d2 has lightness 85%, so when lighten() adds 30% it just returns white.
@debug lighten(#e1d7d2, 30%); // white
// scale() instead makes it 30% lighter than it was originally.
@debug color.scale(#e1d7d2, $lightness: 30%); // #eae3e0
Sass Syntax
@use 'sass:color'
// #e1d7d2 has lightness 85%, so when lighten() adds 30% it just returns white.
@debug lighten(#e1d7d2, 30%) // white
// scale() instead makes it 30% lighter than it was originally.
@debug color.scale(#e1d7d2, $lightness: 30%) // #eae3e0
SCSS Syntax
// Lightness 46% becomes 66%.
@debug lighten(#6b717f, 20%); // #a1a5af
// Lightness 20% becomes 80%.
@debug lighten(#036, 60%); // #99ccff
// Lightness 85% becomes 100%.
@debug lighten(#e1d7d2, 30%); // white
Sass Syntax
// Lightness 46% becomes 66%.
@debug lighten(#6b717f, 20%) // #a1a5af
// Lightness 20% becomes 80%.
@debug lighten(#036, 60%) // #99ccff
// Lightness 85% becomes 100%.
@debug lighten(#e1d7d2, 30%) // white
color.lightness($color)
lightness($color) //=> number
Returns the HSL lightness of $color
as a number between 0%
and 100%
.
The $color
must be in a legacy color space.
⚠️ Heads up!
Because color.lightness()
is redundant with color.channel()
,
it’s no longer recommended. Instead of color.lightness($color)
, you can write
color.channel($color, "lightness")
.
SCSS Syntax
@use 'sass:color';
@debug color.lightness(#e1d7d2); // 85.2941176471%
@debug color.lightness(#f2ece4); // 92.1568627451%
@debug color.lightness(#dadbdf); // 86.4705882353%
Sass Syntax
@use 'sass:color'
@debug color.lightness(#e1d7d2) // 85.2941176471%
@debug color.lightness(#f2ece4) // 92.1568627451%
@debug color.lightness(#dadbdf) // 86.4705882353%
opacify($color, $amount)
fade-in($color, $amount) //=> color
Makes $color
more opaque.
The $color
must be in a legacy color space.
The $amount
must be a number between 0
and 1
(inclusive). Increases the
alpha channel of $color
by that amount.
⚠️ Heads up!
The opacify()
function increases the alpha channel by a fixed amount,
which is often not the desired effect. To make a color a certain percentage
more opaque than it was before, use scale()
instead.
Because opacify()
is usually not the best way to make a color more opaque,
it’s not included directly in the new module system. However, if you have to
preserve the existing behavior, opacify($color, $amount)
can be written
color.adjust($color, $alpha: -$amount)
.
SCSS Syntax
@use 'sass:color';
// rgba(#036, 0.7) has alpha 0.7, so when opacify() adds 0.3 it returns a fully
// opaque color.
@debug opacify(rgba(#036, 0.7), 0.3); // #036
// scale() instead makes it 30% more opaque than it was originally.
@debug color.scale(rgba(#036, 0.7), $alpha: 30%); // rgba(0, 51, 102, 0.79)
Sass Syntax
@use 'sass:color'
// rgba(#036, 0.7) has alpha 0.7, so when opacify() adds 0.3 it returns a fully
// opaque color.
@debug opacify(rgba(#036, 0.7), 0.3) // #036
// scale() instead makes it 30% more opaque than it was originally.
@debug color.scale(rgba(#036, 0.7), $alpha: 30%) // rgba(0, 51, 102, 0.79)
SCSS Syntax
@debug opacify(rgba(#6b717f, 0.5), 0.2); // rgba(107, 113, 127, 0.7)
@debug fade-in(rgba(#e1d7d2, 0.5), 0.4); // rgba(225, 215, 210, 0.9)
@debug opacify(rgba(#036, 0.7), 0.3); // #036
Sass Syntax
@debug opacify(rgba(#6b717f, 0.5), 0.2) // rgba(107, 113, 127, 0.7)
@debug fade-in(rgba(#e1d7d2, 0.5), 0.4) // rgba(225, 215, 210, 0.9)
@debug opacify(rgba(#036, 0.7), 0.3) // #036
color.red($color)
red($color) //=> number
Returns the red channel of $color
as a number between 0 and 255.
The $color
must be in a legacy color space.
⚠️ Heads up!
Because color.red()
is redundant with color.channel()
, it’s
no longer recommended. Instead of color.red($color)
, you can write
color.channel($color, "red")
.
SCSS Syntax
@use 'sass:color';
@debug color.red(#e1d7d2); // 225
@debug color.red(white); // 255
@debug color.red(black); // 0
Sass Syntax
@use 'sass:color'
@debug color.red(#e1d7d2) // 225
@debug color.red(white) // 255
@debug color.red(black) // 0
saturate($color, $amount) //=> color
Makes $color
more saturated.
The $color
must be in a legacy color space.
The $amount
must be a number between 0%
and 100%
(inclusive). Increases
the HSL saturation of $color
by that amount.
⚠️ Heads up!
The saturate()
function increases saturation by a fixed amount, which is
often not the desired effect. To make a color a certain percentage more
saturated than it was before, use scale()
instead.
Because saturate()
is usually not the best way to make a color more
saturated, it’s not included directly in the new module system. However, if
you have to preserve the existing behavior, saturate($color, $amount)
can
be written color.adjust($color, $saturation: $amount, $space: hsl)
.
SCSS Syntax
@use 'sass:color';
// #0e4982 has saturation 80%, so when saturate() adds 30% it just becomes
// fully saturated.
@debug saturate(#0e4982, 30%); // #004990
// scale() instead makes it 30% more saturated than it was originally.
@debug color.scale(#0e4982, $saturation: 30%); // #0a4986
Sass Syntax
@use 'sass:color'
// #0e4982 has saturation 80%, so when saturate() adds 30% it just becomes
// fully saturated.
@debug saturate(#0e4982, 30%) // #004990
// scale() instead makes it 30% more saturated than it was originally.
@debug color.scale(#0e4982, $saturation: 30%) // #0a4986
SCSS Syntax
// Saturation 50% becomes 70%.
@debug saturate(#c69, 20%); // #e05299
// Saturation 35% becomes 85%.
@debug desaturate(#f2ece4, 50%); // #ebebeb
// Saturation 80% becomes 100%.
@debug saturate(#0e4982, 30%) // #004990
Sass Syntax
// Saturation 50% becomes 70%.
@debug saturate(#c69, 20%); // #e05299
// Saturation 35% becomes 85%.
@debug desaturate(#f2ece4, 50%); // #ebebeb
// Saturation 80% becomes 100%.
@debug saturate(#0e4982, 30%) // #004990
color.saturation($color)
saturation($color) //=> number
Returns the HSL saturation of $color
as a number between 0%
and 100%
.
The $color
must be in a legacy color space.
⚠️ Heads up!
Because color.saturation()
is redundant with
color.channel()
, it’s no longer recommended. Instead of
color.saturation($color)
, you can write
color.channel($color, "saturation")
.
SCSS Syntax
@use 'sass:color';
@debug color.saturation(#e1d7d2); // 20%
@debug color.saturation(#f2ece4); // 30%
@debug color.saturation(#dadbdf); // 7.2463768116%
Sass Syntax
@use 'sass:color'
@debug color.saturation(#e1d7d2) // 20%
@debug color.saturation(#f2ece4) // 30%
@debug color.saturation(#dadbdf) // 7.2463768116%
transparentize($color, $amount)
fade-out($color, $amount) //=> color
Makes $color
more transparent.
The $color
must be in a legacy color space.
The $amount
must be a number between 0
and 1
(inclusive). Decreases the
alpha channel of $color
by that amount.
⚠️ Heads up!
The transparentize()
function decreases the alpha channel by a fixed
amount, which is often not the desired effect. To make a color a certain
percentage more transparent than it was before, use
color.scale()
instead.
Because transparentize()
is usually not the best way to make a color more
transparent, it’s not included directly in the new module system. However,
if you have to preserve the existing behavior, transparentize($color, $amount)
can be written color.adjust($color, $alpha: -$amount, $space: hsl)
.
SCSS Syntax
@use 'sass:color';
// rgba(#036, 0.3) has alpha 0.3, so when transparentize() subtracts 0.3 it
// returns a fully transparent color.
@debug transparentize(rgba(#036, 0.3), 0.3); // rgba(0, 51, 102, 0)
// scale() instead makes it 30% more transparent than it was originally.
@debug color.scale(rgba(#036, 0.3), $alpha: -30%); // rgba(0, 51, 102, 0.21)
Sass Syntax
@use 'sass:color'
// rgba(#036, 0.3) has alpha 0.3, so when transparentize() subtracts 0.3 it
// returns a fully transparent color.
@debug transparentize(rgba(#036, 0.3), 0.3) // rgba(0, 51, 102, 0)
// scale() instead makes it 30% more transparent than it was originally.
@debug color.scale(rgba(#036, 0.3), $alpha: -30%) // rgba(0, 51, 102, 0.21)
SCSS Syntax
@debug transparentize(rgba(#6b717f, 0.5), 0.2); // rgba(107, 113, 127, 0.3)
@debug fade-out(rgba(#e1d7d2, 0.5), 0.4); // rgba(225, 215, 210, 0.1)
@debug transparentize(rgba(#036, 0.3), 0.3); // rgba(0, 51, 102, 0)
Sass Syntax
@debug transparentize(rgba(#6b717f, 0.5), 0.2) // rgba(107, 113, 127, 0.3)
@debug fade-out(rgba(#e1d7d2, 0.5), 0.4) // rgba(225, 215, 210, 0.1)
@debug transparentize(rgba(#036, 0.3), 0.3) // rgba(0, 51, 102, 0)
color.whiteness($color) //=> number
- Dart Sass
- since 1.28.0
- LibSass
- ✗
- Ruby Sass
- ✗
Returns the HWB whiteness of $color
as a number between 0%
and 100%
.
The $color
must be in a legacy color space.
⚠️ Heads up!
Because color.whiteness()
is redundant with color.channel()
,
it’s no longer recommended. Instead of color.whiteness($color)
, you can
write color.channel($color, "whiteness")
.
SCSS Syntax
@use 'sass:color';
@debug color.whiteness(#e1d7d2); // 82.3529411765%
@debug color.whiteness(white); // 100%
@debug color.whiteness(black); // 0%
Sass Syntax
@use 'sass:color'
@debug color.whiteness(#e1d7d2) // 82.3529411765%
@debug color.whiteness(white) // 100%
@debug color.whiteness(black) // 0%