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, $alpha: null) adjust-color(...) //=> color
Increases or decreases one or more properties of $color by fixed amounts.
Adds the value passed for each keyword argument to the corresponding property of the color, and returns the adjusted color. It’s an error to specify an RGB property ($red, $green, and/or $blue) at the same time as an HSL property ($hue, $saturation, and/or $lightness), or either of those at the same time as an HWB property ($hue, $whiteness, and/or $blackness).
All optional arguments must be numbers. The $red, $green, and $blue arguments must be unitless and between -255 and 255 (inclusive). The $hue argument must have either the unit deg or no unit. The $saturation, $lightness, $whiteness, and $blackness arguments must be between -100% and 100% (inclusive), and may not be unitless. The $alpha argument must be unitless and between -1 and 1 (inclusive).
See also:
color.scale() for fluidly scaling a color’s properties.color.change() for setting a color’s properties.@debug color.adjust(#6b717f, $red: 15); // #7a717f @debug color.adjust(#d2e1dd, $red: -10, $blue: 10); // #c8e1e7 @debug color.adjust(#998099, $lightness: -30%, $alpha: -0.4); // rgba(71, 57, 71, 0.6)
@debug color.adjust(#6b717f, $red: 15) // #7a717f @debug color.adjust(#d2e1dd, $red: -10, $blue: 10) // #c8e1e7 @debug color.adjust(#998099, $lightness: -30%, $alpha: -0.4) // rgba(71, 57, 71, 0.6)
adjust-hue($color, $degrees) //=> color
Increases or decreases $color‘s hue.
The $hue must be a number between -360deg and 360deg (inclusive) to add to $color’s hue. It may be unitless but it may not have any unit other than deg.
See also color.adjust(), which can adjust any property of a color.
Because adjust-hue() is redundant with 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).
// 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
// 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.
As a special case, this supports the Internet Explorer syntax alpha(opacity=20), for which it returns an unquoted string.
See also:
color.red() for getting a color’s red channel.color.green() for getting a color’s green channel.color.blue() for getting a color’s blue channel.color.hue() for getting a color’s hue.color.saturation() for getting a color’s saturation.color.lightness() for getting a color’s lightness.color.blackness($color) //=> number
Returns the HWB blackness of $color as a number between 0% and 100%.
See also:
color.red() for getting a color’s red channel.color.green() for getting a color’s green channel.color.hue() for getting a color’s hue.color.saturation() for getting a color’s saturation.color.lightness() for getting a color’s lightness.color.whiteness() for getting a color’s whiteness.color.alpha() for getting a color’s alpha channel.color.blue($color) blue($color) //=> number
Returns the blue channel of $color as a number between 0 and 255.
See also:
color.red() for getting a color’s red channel.color.green() for getting a color’s green channel.color.hue() for getting a color’s hue.color.saturation() for getting a color’s saturation.color.lightness() for getting a color’s lightness.color.whiteness() for getting a color’s whiteness.color.blackness() for getting a color’s blackness.color.alpha() for getting a color’s alpha channel.color.change($color, $red: null, $green: null, $blue: null, $hue: null, $saturation: null, $lightness: null, $whiteness: null, $blackness: null, $alpha: null) change-color(...) //=> color
Sets one or more properties of a color to new values.
Uses the value passed for each keyword argument in place of the corresponding property of the color, and returns the changed color. It’s an error to specify an RGB property ($red, $green, and/or $blue) at the same time as an HSL property ($hue, $saturation, and/or $lightness), or either of those at the same time as an HWB property ($hue, $whiteness, and/or $blackness).
All optional arguments must be numbers. The $red, $green, and $blue arguments must be unitless and between 0 and 255 (inclusive). The $hue argument must have either the unit deg or no unit. The $saturation, $lightness, $whiteness, and $blackness arguments must be between 0% and 100% (inclusive), and may not be unitless. The $alpha argument must be unitless and between 0 and 1 (inclusive).
See also:
color.scale() for fluidly scaling a color’s properties.color.adjust() for adjusting a color’s properties by fixed amounts.@debug color.change(#6b717f, $red: 100); // #64717f @debug color.change(#d2e1dd, $red: 100, $blue: 50); // #64e132 @debug color.change(#998099, $lightness: 30%, $alpha: 0.5); // rgba(85, 68, 85, 0.5)
@debug color.change(#6b717f, $red: 100) // #64717f @debug color.change(#d2e1dd, $red: 100, $blue: 50) // #64e132 @debug color.change(#998099, $lightness: 30%, $alpha: 0.5) // rgba(85, 68, 85, 0.5)
color.complement($color) complement($color) //=> color
Returns the RGB complement of $color.
This is identical to color.adjust($color, $hue: 180deg).
// Hue 222deg becomes 42deg. @debug color.complement(#6b717f); // #7f796b // Hue 164deg becomes 344deg. @debug color.complement(#d2e1dd); // #e1d2d6 // Hue 210deg becomes 30deg. @debug color.complement(#036); // #663300
// Hue 222deg becomes 42deg. @debug color.complement(#6b717f) // #7f796b // Hue 164deg becomes 344deg. @debug color.complement(#d2e1dd) // #e1d2d6 // Hue 210deg becomes 30deg. @debug color.complement(#036) // #663300
darken($color, $amount) //=> color
Makes $color darker.
The $amount must be a number between 0% and 100% (inclusive). Decreases the HSL lightness of $color by that amount.
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).
// #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
// #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
// 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
// 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 $amount must be a number between 0% and 100% (inclusive). Decreases the HSL saturation of $color by that amount.
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).
// #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
// #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
// 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
// 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.grayscale($color) grayscale($color) //=> color
Returns a gray color with the same lightness as $color.
This is identical to color.change($color, $saturation: 0%).
color.green($color) green($color) //=> number
Returns the green channel of $color as a number between 0 and 255.
See also:
color.red() for getting a color’s red channel.color.blue() for getting a color’s blue channel.color.hue() for getting a color’s hue.color.saturation() for getting a color’s saturation.color.lightness() for getting a color’s lightness.color.whiteness() for getting a color’s whiteness.color.blackness() for getting a color’s blackness.color.alpha() for getting a color’s alpha channel.color.hue($color) hue($color) //=> number
Returns the hue of $color as a number between 0deg and 360deg.
See also:
color.red() for getting a color’s red channel.color.green() for getting a color’s green channel.color.blue() for getting a color’s blue channel.color.saturation() for getting a color’s saturation.color.lightness() for getting a color’s lightness.color.whiteness() for getting a color’s whiteness.color.blackness() for getting a color’s blackness.color.alpha() for getting a color’s alpha channel.color.hwb($hue $whiteness $blackness) color.hwb($hue $whiteness $blackness / $alpha) color.hwb($hue, $whiteness, $blackness, $alpha: 1) //=> color
Returns a color with the given hue, whiteness, and blackness and the given alpha channel.
The hue is a number between 0deg and 360deg (inclusive). The whiteness and blackness are numbers between 0% and 100% (inclusive). The hue may be unitless, but the whiteness and blackness must have unit %. The alpha channel can be specified as either a unitless number between 0 and 1 (inclusive), or a percentage between 0% and 100% (inclusive).
Sass’s special parsing rules for slash-separated values make it difficult to pass variables for $blackness or $alpha when using the color.hwb($hue $whiteness $blackness / $alpha) signature. Consider using color.hwb($hue, $whiteness, $blackness, $alpha) instead.
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.
@debug color.ie-hex-str(#b37399); // #FFB37399 @debug color.ie-hex-str(#808c99); // #FF808C99 @debug color.ie-hex-str(rgba(242, 236, 228, 0.6)); // #99F2ECE4
@debug color.ie-hex-str(#b37399); // #FFB37399 @debug color.ie-hex-str(#808c99); // #FF808C99 @debug color.ie-hex-str(rgba(242, 236, 228, 0.6)); // #99F2ECE4
color.invert($color, $weight: 100%) invert($color, $weight: 100%) //=> color
Returns the inverse or negative of $color.
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 #808080.
lighten($color, $amount) //=> color
Makes $color lighter.
The $amount must be a number between 0% and 100% (inclusive). Increases the HSL lightness of $color by that amount.
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 adjust($color, $lightness: $amount).
// #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
// #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
// 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
// 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%.
See also:
color.red() for getting a color’s red channel.color.green() for getting a color’s green channel.color.blue() for getting a color’s blue channel.color.hue() for getting a color’s hue.color.saturation() for getting a color’s saturation.color.whiteness() for getting a color’s whiteness.color.blackness() for getting a color’s blackness.color.alpha() for getting a color’s alpha channel.@debug color.lightness(#e1d7d2); // 85.2941176471% @debug color.lightness(#f2ece4); // 92.1568627451% @debug color.lightness(#dadbdf); // 86.4705882353%
@debug color.lightness(#e1d7d2) // 85.2941176471% @debug color.lightness(#f2ece4) // 92.1568627451% @debug color.lightness(#dadbdf) // 86.4705882353%
color.mix($color1, $color2, $weight: 50%) mix($color1, $color2, $weight: 50%) //=> color
Returns a color that’s a mixture of $color1 and $color2.
Both the $weight and the relative opacity of each color determines how much of each color is in the result. 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.
@debug color.mix(#036, #d2e1dd); // #698aa2 @debug color.mix(#036, #d2e1dd, 75%); // #355f84 @debug color.mix(#036, #d2e1dd, 25%); // #9eb6bf @debug color.mix(rgba(242, 236, 228, 0.5), #6b717f); // rgba(141, 144, 152, 0.75)
@debug color.mix(#036, #d2e1dd) // #698aa2 @debug color.mix(#036, #d2e1dd, 75%) // #355f84 @debug color.mix(#036, #d2e1dd, 25%) // #9eb6bf @debug color.mix(rgba(242, 236, 228, 0.5), #6b717f) // rgba(141, 144, 152, 0.75)
opacify($color, $amount) fade-in($color, $amount) //=> color
Makes $color more opaque.
The $amount must be a number between 0 and 1 (inclusive). Increases the alpha channel of $color by that amount.
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 adjust($color, $alpha: -$amount).
// 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)
// 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)
@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
@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.
See also:
color.green() for getting a color’s green channel.color.blue() for getting a color’s blue channel.color.hue() for getting a color’s hue.color.saturation() for getting a color’s saturation.color.lightness() for getting a color’s lightness.color.whiteness() for getting a color’s whiteness.color.blackness() for getting a color’s blackness.color.alpha() for getting a color’s alpha channel.saturate($color, $amount) saturate($color, $amount) //=> color
Makes $color more saturated.
The $amount must be a number between 0% and 100% (inclusive). Increases the HSL saturation of $color by that amount.
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 adjust($color, $saturation: $amount).
// #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
// #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
// 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
// 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%.
See also:
color.red() for getting a color’s red channel.color.green() for getting a color’s green channel.color.blue() for getting a color’s blue channel.color.hue() for getting a color’s hue.color.lightness() for getting a color’s lightness.color.whiteness() for getting a color’s whiteness.color.blackness() for getting a color’s blackness.color.alpha() for getting a color’s alpha channel.color.scale($color, $red: null, $green: null, $blue: null, $saturation: null, $lightness: null, $whiteness: null, $blackness: null, $alpha: null) scale-color(...) //=> color
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.
It’s an error to specify an RGB property ($red, $green, and/or $blue) at the same time as an HSL property ($saturation, and/or $lightness), or either of those at the same time as an HWB property ($whiteness, and/or $blackness).
See also:
color.adjust() for changing a color’s properties by fixed amounts.color.change() for setting a color’s properties.@debug color.scale(#6b717f, $red: 15%); // #81717f @debug color.scale(#d2e1dd, $lightness: -10%, $saturation: 10%); // #b3d4cb @debug color.scale(#998099, $alpha: -40%); // rgba(153, 128, 153, 0.6)
@debug color.scale(#6b717f, $red: 15%) // #81717f @debug color.scale(#d2e1dd, $lightness: -10%, $saturation: 10%) // #b3d4cb @debug color.scale(#998099, $alpha: -40%) // rgba(153, 128, 153, 0.6)
transparentize($color, $amount) fade-out($color, $amount) //=> color
Makes $color more transparent.
The $amount must be a number between 0 and 1 (inclusive). Decreases the alpha channel of $color by that amount.
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).
// 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)
// 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)
@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)
@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
Returns the HWB whiteness of $color as a number between 0% and 100%.
See also:
color.red() for getting a color’s red channel.color.green() for getting a color’s green channel.color.hue() for getting a color’s hue.color.saturation() for getting a color’s saturation.color.lightness() for getting a color’s lightness.color.blackness() for getting a color’s blackness.color.alpha() for getting a color’s alpha channel.
© 2006–2022 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/modules/color