88 KiB
CSS Color Level 4, New Color Spaces: Draft 1.13
(Issue)
This proposal adds Sass support for several new CSS color spaces defined in CSS Color Level 4, including access to non-RGB color models and colors outside the sRGB gamut.
Table of Contents
- Background
- Summary
- Definitions
- Serialization
- Procedures
- New Color Module Functions
- Modified Color Module Functions
- New Global Functions
- Modified Global Functions
- Deprecated Functions
color.red()
,red()
color.green()
,green()
color.blue()
,blue()
color.hue()
,hue()
color.saturation()
,saturation()
color.lightness()
,lightness()
color.whiteness()
color.blackness()
color.alpha()
adjust-hue()
saturate()
desaturate()
transparentize()
,fade-out()
opacify()
,fade-in()
lighten()
darken()
Background
This section is non-normative.
Historically, CSS has only provided authors with color formats using the RGB model, limited to the sRGB gamut. As CSS is used for more applications (such as print) and displays continue to improve, those limitations become more clear. The CSS Color Level 4 specification defines a number of new color spaces, each with its own syntax, representing both new color models and wider RGB gamuts.
-
A color model is a mathematical approach to representing colors and their relationships. Historically, RGB has been the dominant color model for both computer monitors and web browsers. Lately, CIELab and Oklab models have shown significant benefits by providing a more perceptually uniform distribution of colors, so that similar mathematical adjustments achieve visually similar results.
-
A color space is the result of projecting a color model into a coordinate system. In CSS, each color syntax describes a specific (and often unique) color space. For example,
rgb()
,color(srgb)
, andcolor(display-p3)
all project the RGB color model into cubic coordinate systems, whilehsl()
projects the same color model into a cylindrical (polar-angle) space. Similarly,oklab()
andoklch()
provide different coordinate projections of the Oklab model. -
A color gamut is the full range of colors that can be described in a color space. Historically, all CSS syntaxes have been limited to the sRGB gamut. However, modern computer monitors often support wider gamuts. Color spaces like
srgb
anddisplay-p3
describe different gamuts of color, using the same underlying RGB color model, and differently-mapped cubic coordinates.
These terms can get a bit confusing, since there is so much overlap. The term
'RGB' can refer to a color model, a color space, a coordinate system, and also
a color function. The 'RGB' color space is identical to the 'sRGB' space, and
both describe the 'sRGB' gamut. But we have both rgb()
and color(srgb)
syntax, in order to distinguish legacy from non-legacy variations. They also
have different coordinate systems, rgb()
accepts a range from 0-255, while
color(srgb)
accept values from 0-1.
The result is that authors can generally think of each color syntax as a unique
space, and each space implies an associated gamut and coordinate system. Color
spaces become a simple way to refer to all parts combined. We've used that same
approach in Sass, such that the name of a color space can be used to reference
the associated gamut. For example, color.to-gamut($color, hsl)
and
color.to-gamut($color, srgb)
have the same meaning, both mapping a color into
the sRGB gamut.
Since all CSS colors up until this point have been restricted to RGB math in the sRGB gamut, Sass has historically treated all color formats and spaces as interchangeable. That has allowed authors to inspect and manipulate colors in any space, without careful management or gamut mapping. It has also allowed Sass to output the most browser-compatible CSS format for any given color.
In order to support the color spaces in CSS, Sass will need to start tracking the space/gamut associated with any given color, and provide author tools for managing those color spaces/gamuts. In addition to supporting the new color space functions, we plan to update all functions in the color module, and provide some additional space and gamut management and inspection functions.
Summary
This section is non-normative.
This proposal defines a Sass representation of colors with color spaces, Sassified versions of all the color functions in CSS Color Level 4, updated definitions of existing Sass functions to accommodate color spaces, and several new Sass-specific color functions as well.
Rules of Thumb
There are several rules of thumb for working with color spaces in Sass:
-
The
rgb
,hsl
, andhwb
spaces are considered "legacy spaces", and will often get special handling for the sake of backwards compatibility. Colors defined using hex notation or CSS color names are considered part of thergb
color space. Legacy colors are emitted in the most compatible format. This matches CSS's own backwards-compatibility behavior. -
Otherwise, any color defined in a given space will remain in that space, and be emitted in that space.
-
Authors can explicitly convert a color's space by using
color.to-space()
. This can be useful to enforce non-legacy behavior, by converting into a non-legacy space, or to ensure the color output is compatible with older browsers by converting colors into a legacy space before emitting. -
The
srgb
color space is equivalent torgb
, except that one is a legacy space, and the other is not. They also use different coordinate systems, withrgb()
accepting a range from 0-255, andsrgb
using a range of 0-1. -
Color functions that allow specifying a color space for manipulation will always use the source color space by default. When an explicit space is provided for manipulation, the resulting color will still be returned in the same space as the origin color. For
color.mix()
, the first color parameter is considered the origin color. -
All legacy and RGB-style spaces represent bounded gamuts of color. Since mapping colors into gamut is a lossy process, it should generally be left to browsers, which can map colors as-needed, based on the capabilities of a display. For that reason, out-of-gamut channel values are maintained by Sass whenever possible, even when converting into gamut-bounded color spaces. The only exception is that
hsl
andhwb
color spaces are not able to express out-of-gamut color, so converting colors into those spaces will gamut-map the colors as well. Authors can also perform explicit gamut mapping with thecolor.to-gamut()
function. -
Legacy browsers require colors in the
srgb
gamut. However, most modern displays support the widerdisplay-p3
gamut.
Standard CSS Color Functions
oklab()
and oklch()
The oklab()
(cubic) and oklch()
(cylindrical) functions provide access to an
unbounded gamut of colors in a perceptually uniform space. Authors can use these
functions to define reliably uniform colors. For example, the following colors
are perceptually similar in lightness and saturation:
$pink: oklch(64% 0.196 353); // hsl(329.8 70.29% 58.75%)
$blue: oklch(64% 0.196 253); // hsl(207.4 99.22% 50.69%)
The oklch()
format uses consistent "lightness" and "chroma" values, while the
hsl()
format shows dramatic changes in both "lightness" and "saturation". As
such, oklch
is often the best space for consistent transforms.
lab()
and lch()
The lab()
and lch()
functions provide access to an unbounded gamut of colors
in a space that's less perpetually-uniform but more widely-adopted than Oklab
and Oklch.
hwb()
Sass now supports a top-level hwb()
function that uses the same syntax as
CSS's built-in hwb()
syntax.
color()
The new color()
function provides access to a number of specialty spaces. Most
notably, display-p3
is a common space for wide-gamut monitors, making it
likely one of the more popular options for authors who simply want access to a
wider range of colors. For example, P3 greens are significantly 'brighter' and
more saturated than the greens available in sRGB:
$fallback-green: rgb(0% 100% 0%);
$brighter-green: color(display-p3 0 1 0);
Sass will natively support all predefined color spaces declared in the Colors Level 4 specification.
New Sass Color Functions
color.channel()
This function returns the value of a single channel in a color. By default, it
only supports channels that are available in the color's own space, but you can
pass the $space
parameter to return the value of the channel after converting
to the given space.
$brand: hsl(0 100% 25.1%);
// result: 25.1%
$hsl-lightness: color.channel($brand, "lightness");
// result: 37.67%
$oklch-lightness: color.channel($brand, "lightness", $space: oklch);
color.is-missing()
This function returns if a given channel value is 'missing' (set to none
).
This is necessary, since color.channel
returns 0
for missing channels.
Since color-space conversion can change what channels are missing, this
function only supports inspecting channels that are part of the color's own
space.
$brand: hsl(none 100% 25.1%);
// result: false
$missing-lightness: color.is-missing($brand, "lightness");
// result: true
$missing-hue: color.is-missing($brand, "hue");
color.space()
This function returns the name of the color's space.
// result: hsl
$hsl-space: color.space(hsl(0 100% 25.1%));
// result: oklch
$oklch-space: color.space(oklch(37.7% 38.75% 29.23deg));
color.is-in-gamut()
, color.is-legacy()
These functions return various facts about the color. color.is-in-gamut()
returns whether the color is in-gamut for its color space (as opposed to having
one or more of its channels out of bounds, like rgb(300 0 0)
).
color.is-legacy()
returns whether the color is a legacy color in the rgb
,
hsl
, or hwb
color space.
color.to-gamut()
This function returns a color that is in the given gamut, using the recommended CSS Gamut Mapping Algorithm to 'map' out-of-gamut colors into the desired gamut with as little perceptual change as possible. In many cases this can be more reliable for generating fallback values, rather than the 'channel clipping' approach used by current browsers.
$green: oklch(0.8 2 150);
// oklch(0.91 0.14 164)
$rgb: color.to-gamut($green, "srgb");
// oklch(0.91 0.16 163)
$p3: color.to-gamut($green, "display-p3");
color.is-powerless()
This function returns whether a given channel is "powerless" in the given color. This is a special state that's defined for individual color spaces, which indicates that a channel's value won't affect how a color is displayed.
$grey: hsl(0 0% 60%);
// result: true, because saturation is 0
$hue-powerless: color.is-powerless($grey, "hue");
// result: false
$hue-powerless: color.is-powerless($grey, "lightness");
color.same()
This function returns whether two colors will be displayed the same way, even if
this requires converting between spaces. This is unlike the ==
operator, which
always considers colors in different non-legacy spaces to be inequal.
$orange-rgb: #ff5f00;
$orange-oklch: oklch(68.72% 20.966858279% 41.4189852913deg);
// result: false
$equal: $orange-rgb == $orange-oklch;
// result: true
$same: color.same($orange-rgb, $orange-oklch);
Existing Sass Color Functions
color.scale()
, color.adjust()
, and color.change()
By default, all Sass color transformations are handled and returned in the color
space of the original color parameter. However, all relevant functions now allow
specifying an explicit color space for transformations. For example, lightness &
darkness adjustments are most reliable in oklch
:
$brand: hsl(0 100% 25.1%);
// result: hsl(0 100% 43.8%)
$hsl-lightness: color.scale($brand, $lightness: 25%);
// result: hsl(5.76 56% 45.4%)
$oklch-lightness: color.scale($brand, $lightness: 25%, $space: oklch);
Note that the returned color is still emitted in the original color space, even when the adjustment is performed in a different space.
color.mix()
The color.mix()
function will retain its existing behavior for legacy color
spaces, but for new color spaces it will match CSS's "color interpolation"
specification. This is how CSS computes which color to use in between two colors
in a gradient or an animation.
Deprecations
A number of existing functions only make sense for legacy colors, and so are
being deprecated in favor of color-space-friendly functions like
color.channel()
and color.adjust()
:
color.red()
color.green()
color.blue()
color.hue()
color.saturation()
color.lightness()
color.whiteness()
color.blackness()
color.alpha()
adjust-hue()
saturate()
desaturate()
transparentize()
/fade-out()
opacify()
/fade-in()
lighten()
/darken()
Design Decisions
Unclamped Channels
Most of the design decisions involved in the proposal are based on the CSS Color Level 4 specification, which we have tried to emulate as closely as possible while maintaining support for legacy projects. In some cases, that required major changes to the way Sass handles colors:
-
Channel values are no longer internally clamped to the gamut of a color space. By default Sass will output CSS with out-of-gamut colors, because these colors are handled differently when doing interpolation across different color spaces. Browsers may also eventually handle gamut-mapping for these colors, although at the time of writing they do not. Authors can also use the provided
color.to-gamut()
function to force a color to be mapped into the gamut of its native color space. -
RGB-style channel values are no longer rounded to the nearest integer, since the spec now requires maintaining precision wherever possible. This is especially important in RGB spaces, where color distribution is inconsistent.
Clamped Channels
Per the CSS specs, certain channels are clamped at parse time but not in interpolation for specific color functions:
- All channels of the
rgb()
andrgba()
functions. - The lightness channel of the
lab()
,lch()
,oklab()
, andoklch()
functions. - The lower bound of the chroma channel of the
lch()
andoklch()
functions.
However, it's necessary to use out-of-gamut values in these spaces to represent
valid colors from other spaces—for example, color(xyz 1 1 1)
is equivalent to
lab(100.12% 9.0645 5.8018)
and color(prophoto-rgb 0 1 0)
is equivalent to
rgb(-221.6192400378, 279.4082218845, -109.1140773956)
. To match the behavior
of CSS, we have to clamp these channels when constructing colors directly
through color functions, so writing lab(110% 0 0)
will return lab(100% 0 0)
.
On the other hand, to preserve colors on a round trip between spaces, we need to
allow the internal representation of these colors to go out-of-gamut.
The question remains as to how to handle cases that don't directly correspond to
CSS, such as the color.change()
function. Because out-of-gamut clamped
channels are meaningful in CSS, we've chosen the design principle of preserving
them in all situations where clamping isn't specifically mandated by CSS. In
addition, to ensure that that the colors represent the same values in CSS that
they do in Sass, they'll be serialized to special formats that preserves their
out-of-gamut values:
-
Out-of-gamut RGB colors are serialized to
hsl()
, the lightness channel and saturation upper bound of which per spec are not clamped at parse-time (although in practice browsers do clamp them at time of writing). This ensures that older browsers will still handle these colors somewhat correctly while preserving the unclamped value for modern browsers (once they work per spec). -
Out-of-gamut Lab, LCH, OKLab, and OKLCH colors are serialized to
color-mix(in ..., color(xyz ...) 100%, black)
to preserve both the original color space and the unclamped value in conformant browsers.
Changing Color Spaces
Different color spaces often represent different color-gamuts, which can present
a new set of problems for authors. Some color manipulations are best handled
in a wide-gamut space like oklch
, but (for now) authors will likely prefer
emitting legacy colors that work in existing and legacy browsers. While that
is likely to change in the long term, we think it's a worthwhile tradeoff to
prioritize author control and legacy color use-cases. Authors who do choose to
emit non-legacy colors are less likely to be working in legacy color spaces to
begin with. So we've established the following guidelines for color conversion
and mapping in Sass color functions:
-
Every color function returns a color in the same space as the original color, no matter what space was used for transformations. The only exception is
color.to-space()
, which can be used for manual space conversion. Functions that accept two colors (e.g.color.mix()
) return a color in the same space as the first color argument. -
No color function performs gamut-mapping on out-of-gamut channels, except
color.to-gamut()
, which can be used for manual gamut-mapping.
Gamut Mapping
Browsers currently use channel-clipping rather than the proposed
css gamut mapping algorithm to handle colors that cannot be
shown correctly on a given display. We've decided to provide color.to-gamut()
as a way for authors to opt-into the proposed behavior, aware that browsers
may eventually choose to provide a different algorithm. If that happens, we
will consider adding an additional algorithm-selection argument. However, the
primary goal of this function is not to match CSS behavior, but to provide a
better mapping than the default channel-clipping.
CSS Color 5
We are not attempting to support all of CSS Color Level 5 at this
point, since it is not yet implemented in browsers. However, we have used it as
a reference while updating color manipulation functions such as color.mix()
.
There is also an open issue in CSS to determine how the relative color syntax
from Level 5 should handle missing color components. Since the relative color
syntax provides similar functionality to the Sass color.adjust()
and
color.scale()
functions, we have decided to wait and match the CSS behavior
once it is specified. In the meantime, Sass will throw errors when trying to
adjust or scale a missing component. This is not the ideal behavior, but it
provides us with the most flexibility to change our behavior in the future.
Special Thanks
Thanks to the editors of the CSS Color Level 4 specification (Tab Atkins Jr., Chris Lilley, and Lea Verou) for answering our many questions along the way. We also used Chris and Lea's Color.js library as a reference as we developed this proposal.
Definitions
Color
Note that channel values are stored as specified, maintaining precision where possible, even when the values are out-of-gamut for the known color space.
A color is an object with several parts:
-
A color space that is either a known color space or an unquoted string.
-
An ordered list of channels, each one containing a double or the special value
none
. -
An alpha that is either the special value
none
or a double between0-1
(inclusive).While it's valid to specify numbers outside this range, they are meaningless, and can be clamped by input functions when generating a color.
Legacy Color
Both Sass and CSS have similar legacy behavior that relies on all colors being interchangeable as part of a shared
srgb
color space. While the new color spaces will opt users into new default behavior, some legacy color spaces behave differently for the sake of backwards-compatibility.
Colors in the rgb
, hsl
, or hwb
color spaces are
considered legacy colors. The output of a legacy color is not required to
match the input color space, and several color functions maintain legacy
behavior when manipulating legacy colors.
Legacy colors that have missing components are serialized as non-legacy colors.
This includes colors defined using the CSS color names, hex syntax,
rgb()
,rgba()
,hsl()
,hsla()
, orhwb()
-- along with colors that are manually converted into legacy color spaces.
Color Equality
For determining equality between two colors:
-
If both colors are legacy colors:
-
Set each color to the result of converting the color into
rgb
space. -
Colors are only equal if their channel and alpha values are fuzzy-equal.
Since this definition no longer involves rounding channels, it is potentially a breaking change. Moving forward,
rgb(0 0 0.6) != rgb(0 0 1)
.
-
-
Otherwise, colors are only equal when they're in the same color space and their channel and alpha values are fuzzy-equal.
Known Color Space
Each known color space has a name and an ordered list of associated channels. Each channel has a name, and an associated unit where allowed. Space and channel names match unquoted strings, ignoring case. They are always emitted as unquoted lowercase strings by inspection functions.
Values outside a bounded gamut range (including infinity or negative infinity) are valid but are considered out of gamut for the given color space. They remain un-clamped unless the gamut is specifically marked as "clamped", in which case they're clamped only when constructing the color from its global constructor function. If the channel is bounded, or has a percentage mapping, then the channel is considered scalable.
Some color spaces use a polar angle value for the hue
channel. Polar-angle
hues represent an angle position around a given hue wheel, using a CSS <angle>
dimension or number (interpreted as a deg
value), and are serialized with
deg
units.
Colors specified using a CSS color keyword or the hex notation are converted
to rgb
and serialized as part of the rgb
color space.
The known color spaces and their channels are:
-
rgb
(RGB, legacy):red
,green
,blue
:-
gamut: bounded, clamped
-
number:
[0,255]
Percentages
[0%,100%]
map to the[0,255]
range.
-
-
hwb
(RGB, legacy):hue
:- associated unit:
deg
- degrees: polar angle
- associated unit:
whiteness
,blackness
:- associated unit:
%
- gamut: bounded
- percentage:
[0%,100%]
- associated unit:
-
hsl
(RGB, legacy):hue
:- associated unit:
deg
- degrees: polar angle
- associated unit:
saturation
:- gamut: bounded, clamped (lower bound only)
- associated unit:
%
- percentage:
[0%,100%]
lightness
:- gamut: bounded
- associated unit:
%
- percentage:
[0%,100%]
-
srgb
,srgb-linear
,display-p3
,a98-rgb
,prophoto-rgb
,rec2020
(RGB):red
,green
,blue
:-
gamut: bounded
-
number:
[0,1]
Percentages
[0%,100%]
map to the[0,1]
range.
-
-
xyz
,xyz-d50
,xyz-d65
:x
,y
,z
:-
gamut: un-bounded
-
number:
[0,1]
Percentages
[0%,100%]
map to the[0,1]
range.
-
-
lab
:-
lightness
:-
gamut: un-bounded, clamped
-
associated unit:
%
-
number:
[0,100]
Percentages
[0%,100%]
map to the[0,100]
range.
-
-
a
,b
:-
gamut: un-bounded
-
number:
[-125,125]
Percentages
[-100%,100%]
map to the[-125,125]
range.
-
-
-
lch
:-
lightness
:-
gamut: un-bounded, clamped
-
associated unit:
%
-
number:
[0,100]
Percentages
[0%,100%]
map to the[0,100]
range.
-
-
chroma
:-
gamut: un-bounded, clamped (lower bound only)
-
number:
[0,150]
Percentages
[0%,100%]
map to the[0,150]
range.
-
-
hue
:- associated unit:
deg
- degrees: polar angle
- associated unit:
-
-
oklab
:-
lightness
:-
gamut: un-bounded, clamped
-
associated unit:
%
-
number:
[0,1]
Percentages
[0%,100%]
map to the[0,1]
range.
-
-
a
,b
:-
gamut: un-bounded
-
number:
[-0.4,0.4]
Percentages
[-100%,100%]
map to the[-0.4,0.4]
range.
-
-
-
oklch
:-
lightness
:-
gamut: un-bounded, clamped
-
associated unit:
%
-
number:
[0,1]
Percentages
[0%,100%]
map to the[0,1]
range.
-
-
chroma
:-
gamut: un-bounded, clamped (lower bound only)
-
number:
[0,0.4]
Percentages
[0%,100%]
map to the[0,0.4]
range.
-
-
hue
:- associated unit:
deg
- degrees: polar angle
- associated unit:
-
If a color with negative saturation or chroma would be created in the hsl
,
lch
, or oklch
spaces by any means, instead create a color with the absolute
value of that saturation or chroma and the hue rotated by 180deg.
This is an equivalent color, and in fact passing channels with negative saturation/chroma through conversion to other color spaces and back will produce this same result. This helps ensure that identical colors are represented uniformly.
Note that this conversion happens after any clipping, so
hsl(0deg -50% 50%)
returnshsl(0deg 0% 50%)
, nothsl(180deg 50% 50%)
.
Predefined Color Spaces
'Predefined color spaces' can be described using the
color()
function.
The predefined RGB spaces are:
srgb
srgb-linear
display-p3
a98-rgb
prophoto-rgb
rec2020
The predefined XYZ spaces are:
xyz
xyz-d50
xyz-d65
(an alias forxyz
)
Missing Components
In some cases, a color can have one or more missing components (channel or
alpha values). Missing components are represented by the special value none
.
When interpolating between colors, the missing component is replaced by the
value of that same component in the other color. In all other cases, the
missing value is treated as 0
.
For the sake of interpolating between colors with missing components, the following analogous components are defined by CSS Color Level 4:
Category | Components |
---|---|
Reds | red, x |
Greens | green, y |
Blues | blue, z |
Lightness | lightness |
Colorfulness | chroma, saturation |
Hue | hue |
Powerless Components
In some color spaces, it is possible for a channel value to become 'powerless' in certain circumstances.
-
hsl
:- If the
saturation
value is0%
, then thehue
channel is powerless.
- If the
-
hwb
:- If the combined
whiteness
andblackness
values (after normalization) are equal to100%
, then thehue
channel is powerless.
- If the combined
-
lch
/oklch
:- If the
chroma
value is 0%, then thehue
channel is powerless.
- If the
Color Interpolation Method
A color interpolation method is a space-separated list of unquoted strings, parsed according to the following syntax definition:
ColorInterpolationMethod ::= RectangularColorSpace | (PolarColorSpace HueInterpolationMethod?) HueInterpolationMethod ::= ( 'shorter' | 'longer' | 'increasing' | 'decreasing' ) 'hue'
A valid PolarColorSpace is the name of a known color space with a polar
angle hue channel. A RectangularColorSpace is the name of any other
known color space, without a polar-angle hue. The interpolation color space
is the result of looking up a known color space named by either the
PolarColorSpace
or RectangularColorSpace
productions.
Different color interpolation methods provide different advantages. For that reason, individual color procedures and functions can establish their own color interpolation defaults, or provide a syntax for authors to explicitly choose the method that best fits their need. The CSS Color Level 4 specification provides additional guidance for determining appropriate defaults.
Serialization
Serialization of Non-Legacy Colors
To serialize a non-legacy color color
:
-
Let
space-name
be an unquoted lowercase string ofcolor
's space name. -
If
color
has a clamped channel whose value is out-of-bounds, emit a CSS<color>
expression that evaluates tocolor
's value, then return.The specific syntax here is left up to implementations, based on the specifics of the color in question and the realities of browser support. Two options include:
-
color-mix()
. For example,color-mix(in lab, color(xyz 1 1 1) 100%, black)
will losslessly convertcolor(xyz 1 1 1)
intolab
where the nativelab
syntax would clamp the lightness at100%
. -
Relative color syntax, which per spec is never clamped. For example, while the lightness in
lab(200 50 50)
is clamped, the lightness inlab(from black 200 50 50)
is not.
At the time of writing, browser support is patchy for these syntaxes and no browser correctly avoids clipping in all the cases we're relying on. Although we have no way of ensuring that all color values representable in Sass can be correctly loaded by browsers, this spec aims to ensure that Sass generates the correct value according to the CSS spec and that implementations have enough flexibility within that to target the shifting landscape of what browsers actually support.
-
-
Let
known-space
be the result of looking up a known color space with aname
ofspace-name
. -
Let
components
be an empty space-separated list. -
For each
channel
incolor
's channels:-
If
channel
is missing a value, setchannel
to the unquoted string "none". -
Otherwise:
-
Let
unit
be the unit associated withchannel
inknown-space
, if defined, andnull
otherwise. -
If
unit
is not null, appendunit
units to thechannel
value.
-
-
Append
channel
as the last element ofcomponents
.
-
-
Let
alpha
be the alpha value ofcolor
. -
If
alpha != 1
:- Set
components
to the result of appending " / " and then the values ofalpha
to the end ofcomponents
.
- Set
-
If
color
has a known color space that is not a predefined color space:Since a predefined color space is defined as a known color space that uses the
color()
syntax, this is a reliable way to get the remaining known color spaces that provide their own function syntax.- Emit
space-name
followed by "(",components
, and then ")".
- Emit
-
Otherwise, emit "color(", followed by
space-name
, " ",components
, and then ")".
Serialization of Out-of-Gamut RGB Colors
To serialize an out-of-gamut color color
in the rgb
space:
-
Let
hsl
be the result of convertingcolor
into thehsl
space. -
Return the result of serializing
hsl
.
Procedures
Looking Up a Known Color Space
This procedure accepts a name
, and attempts to look up a known color space
with a matching name. It throws an error if name
is not a valid color space
name, and either returns the known color space, or null
if no color space is
matched.
-
If
name
is not an unquoted string, throw an error. -
Let
lower-name
be the result of callingstring.to-lower-case(name)
. -
If
lower-name
is the name of a known color space, return the matching known color space. -
Otherwise, throw an error.
In the future, we can add support for custom/unknown spaces by returning
null
when no space is found.
Converting a Color
Colors can be converted from one known color space to another. This procedure
accepts a color origin-color
, and a known color space target-space
, and
returns a color color
.
Since the individual CSS color conversion algorithms don't explicitly handle the process of 'carrying over' missing values on analogous channels, we have to handle that here.
-
Let
origin-space
beorigin-color
's color space. -
If
origin-space == target-space
returnorigin-color
.CSS doesn't perform conversions unless they are required.
-
Let
missing
be a list of channel names inorigin-color
that are missing. -
Let
color
be the result of css-convertingorigin-color
intotarget-space
. -
For each
channel
inmissing
:- If
target-space
has an analogous component tochannel
, set the analogous component incolor
tonone
.
- If
-
If any
channel
ofcolor
is powerless and not already missing, setchannel
to the special valuenone
. -
Return
color
.
CSS-Converting a Color Space
Algorithms for individual color space conversion are defined in the
CSS Color Level 4 specification. CSS color conversion takes a
color origin-color
, and a known color space target-space
, and returns a
color output-color
.
The individual conversion algorithms are:
For additional details, see the Sample code for color conversions.
Gamut Mapping
Some known color spaces describe limited color gamuts. If a color is 'out of gamut' for a particular space (most often because of conversion from a larger-gamut color-space), it can be useful to 'map' that color to the nearest available 'in-gamut' color. Gamut mapping is the process of finding an in-gamut color with the least objectionable change in visual appearance.
Gamut mapping in Sass follows the CSS gamut mapping algorithm.
This procedure accepts a color origin
, and a known color space
destination
. It returns the result of a CSS gamut map procedure,
converted back into the original color space.
-
Let
origin-space
beorigin
's color space. -
If either
origin-space
ordestination
is not a known color space, throw an error. -
Let
mapped
be the result of CSS gamut mappingorigin
color, with an origin color space oforigin-space
, and destination ofdestination
. -
Return the result of converting
mapped
intoorigin-space
.
This algorithm implements a relative colorimetric intent, and colors inside the destination gamut are unchanged. Since the process is lossy, authors should be encouraged to let the browser handle gamut mapping when possible.
Parsing Color Components
This procedure accepts an input
parameter to parse, along with an optional
known color space space
. It throws common parse errors when necessary, and
returns either a single string of components to emit in a CSS function, or
three values: a color space, a list of channel values, and an alpha value.
This supports both the space-specific color formats like
hsl()
andrgb()
, where the space is determined by the function, as well as the syntax ofcolor()
, where the space is included as one of the input arguments (and may be a user-defined space).
The procedure is:
-
If
input
is a special variable string, return an unquoted string with the value ofinput
. -
If
input
is a bracketed list, or a list with a separator other than 'slash' or 'space', throw an error. -
If
input
is a slash-separated list:-
If
input
doesn't have exactly two elements, throw an error. -
Otherwise, let
components
be the first element andalpha
the second element ofinput
.
-
-
Otherwise:
-
Let
components
be an unbracketed space separated list of all except the last element ofinput
. -
If the last element of
input
is an unquoted string that contains/
:-
Let
split-last
be the result callingstring.split()
with the last element ofinput
as the string to split, and/
as the separator. -
If
split-last
has two items, and one or both items are an unquoted string that's case-insensitively equal to 'none':Special handling for
none/none
,none/<number>
, and<number>/none
.-
If either item in
split-last
can be coerced to a number, replace the current value of the item with the resulting number value. -
If any item in
split-last
is not a number or an unquoted string that's case-insensitively equal to 'none', return an unquoted string with the value ofinput
. -
Otherwise, let
alpha
be the second element insplit-last
, and append the first element ofsplit-last
tocomponents
.
-
-
Otherwise, return an unquoted string with the value of
input
.This solves for a legacy handling of
/
in Sass that would produce an unquoted string when the alpha value is a CSS function such asvar()
or when either value isnone
.
-
-
Otherwise, if the last element of
input
has preserved its status as two slash-separated numbers:- Let
alpha
be the number after the slash, and append the number before the slash tocomponents
.
- Let
-
Otherwise, append the last element of
input
tocomponents
.
-
-
If
components
is an empty list, throw an error. -
If
components
is a special variable string:- Let
channels
be the value ofcomponents
.
- Let
-
Otherwise:
-
If
components
is not an unbracketed space-separated list, throw an error. -
If the first element of
components
is an unquoted string which is case-insensitively equal tofrom
, return an unquoted string with the value ofinput
. -
If
space
is null:-
Let
input-space
be the first element incomponents
. -
If
input-space
is a special variable string, return an unquoted string with the value ofinput
. -
Set
space
be the result of looking up a known color space with the nameinput-space
. -
If
space
is not a predefined color space, throw an error.Only predefined spaces can be passed in as color syntax components. All other known color spaces use explicit functions.
-
Let
channels
be an unbracketed space-separated list with the remaining elements fromcomponents
.
-
-
Otherwise, let
channels
be the value ofcomponents
. -
Let
expected
be the number of channels inspace
. -
If any element of
channels
is not either a number, a special variable string, a special number, or an unquoted string that's case-insensitively equal to 'none', throw an error.
-
-
If
alpha
is null, letalpha
be1
. -
Otherwise, If
alpha
is not a special number:-
If
alpha
is a number, setalpha
to the result of percent-convertingalpha
with a max of 1, and then clamping the value between 0 and 1, inclusive. -
Otherwise, throw an error.
-
-
If
channels
is a special variable string, or ifalpha
is a special number, return an unquoted string with the value ofinput
. -
If any element of
channels
is a special number:-
If
space
is a legacy color space:-
Let
comma-list
be the result of callinglist.append(channels, alpha, 'comma')
. -
Return an unquoted string with the value of
comma-list
.
-
-
Otherwise, return an unquoted string with the value of
input
.Doing this late in the process allows us to throw any obvious syntax errors, even for colors that can't be fully resolved during compilation.
-
-
If the length of
channels
is not equal toexpected
, throw an error.Once special values have been handled, any colors remaining should have exactly the expected number of channels.
-
Set
channels
to the result of normalizingchannels
inspace
. -
Let
space-name
be a lowercase unquoted string of thespace
name. -
Return
space-name
,channels
channels, andalpha
alpha value.
Percent-Converting a Number
This algorithm takes a SassScript number number
and a number max
. It returns
a number relative to the range [0,max]
without clamping.
In order to support both out-of-gamut channels and unbounded ranges, this value is no longer clamped between 0 and
max
-
If
number
has units other than%
, throw an error. -
If
number
has the unit%
, setnumber
tonumber * max / 100%
. -
Return
number
.
Validating a Color Channel
This process accepts a SassScript value channel
to validate, a known color
space space
to validate against, and the key
name of the channel. It
throws an error if the channel is invalid for the color space, or returns a
normalized channel value otherwise.
-
If
channel
is not a number or an unquoted string that's case-insensitively equal to 'none', throw an error. -
If
channel == NaN
, throw an error. -
If
channel
is an unquoted string that's case-insensitively equal to 'none', returnchannel
. -
Otherwise:
-
Let
valid
be the corresponding channel namedkey
defined by the known color spacespace
. -
If
valid
is a polar-anglehue
:-
Let
angle
be the result of convertingchannel
todeg
allowing unitless. -
Return the result of
angle % 360deg
.
-
-
Otherwise, if
valid
requires a percentage:-
If
channel
is a number with units other than%
, throw an error. -
Return
channel
.
-
-
Otherwise, set
channel
to the result of percent-convertingchannel
with amin
andmax
defined by thevalid
channel range. -
If this was (transitively) invoked from the global
rgb()
,lab()
,lch()
,oklab()
,oklch()
, orcolor()
function andvalid
is a clamped channel, return the result of clampingchannel
to its native range. -
Return
channel
.
-
Normalizing Color Channels
This process accepts a list of channels
to validate and a known color space
space
to normalize against. It throws an error if any channel is invalid for
the color space, or returns a normalized list of valid channels otherwise.
-
If
channels
is not a list, throw an error. -
If
space
is not a known color space, throw an error. -
Let
normal
be an empty list. -
For each
channel
inchannels
:-
Let
key
be the name ofchannel
inspace
. -
Let
valid
be the result of validatingchannel
askey
channel inspace
. -
Append
valid
as the next item innormal
.
-
-
Let
unitless
be an empty list. -
For each
channel
innormal
.-
If the value of
channel
is the special valuenone
, appendnone
as the next item inunitless
. -
Otherwise, append the value of
channel
as a double without units as the next item inunitless
.
-
-
Return
unitless
.
Interpolating Legacy Colors
This procedure is based on the legacy behavior of the
color.mix()
function, but returns a color in the originalcolor1
color space.
This procedure accepts two legacy colors (color1
and color2
), and an
optional percentage weight
for color1
in the mix. It returns a new color
mix
that represents the appropriate mix of input colors.
-
Let
origin-space
becolor1
's color space. -
Let
rgb1
andrgb2
be the result of convertingcolor1
andcolor2
respectively intorgb
. -
If
weight
is null, setweight-scale
to0.5
. -
Otherwise, set
weight-scale
to the result of percent-convertingweight
with a max of 1, and then clamping the value between 0 and 1 (inclusive). -
Let
normal-weight
beweight-scale * 2 - 1
. -
Let
alpha1
andalpha2
be the alpha values ofrgb1
andrgb2
respectively. -
Let
alpha-distance
bealpha1 - alpha2
. -
Let
weight-by-distance
benormal-weight * alpha-distance
. -
If
weight-by-distance == -1
, letcombined-weight1
benormal-weight
. -
Otherwise:
-
Let
weight-distance-sum
benormal-weight + alpha-distance
. -
Let
combined-weight1
beweight-distance-sum / (1 + weight-by-distance)
.
-
-
Let
weight1
be(combined-weight1 + 1) / 2
. -
Let
weight2
be1 - weight1
. -
Let
red1
andred2
be the red channels ofrgb1
andrgb2
respectively. -
Let
red
bered1 * weight1 + red2 * weight2
. -
Let
green1
andgreen2
be the green channels ofrgb1
andrgb2
respectively. -
Let
green
begreen1 * weight1 + green2 * weight2
. -
Let
blue1
andblue2
be the blue channels ofrgb1
andrgb2
respectively. -
Let
blue
beblue1 * weight1 + blue2 * weight2
. -
Let
alpha
bealpha1 * weight-scale + alpha2 * (1 - weight-scale)
. -
Let
mix
be a legacy color in thergb
space, with the givenred
,green
, andblue
channels, andalpha
value. -
Return the result of converting
mix
intoorigin-space
.
Interpolating Colors
This procedure is based on the color interpolation procedures defined in CSS Color Level 4.
This procedure accepts two color arguments (color1
and color2
), a
color interpolation method method
, and a percentage weight
for color1
in the mix. It returns a new color mix
that represents the appropriate mix of
input colors.
-
If either
color1
orcolor2
is not a color in a known color space, throw an error. -
Let
origin-space
becolor1
's color space. -
If
weight
is null, setweight
to0.5
. -
Otherwise, set
weight
to the result of percent-convertingweight
with a max of 1. -
If
weight > 1
orweight < 0
, throw an error. -
If
weight == 0
, returncolor2
. -
If
weight == 1
, returncolor1
. -
Let
space
be the interpolation color space specified by themethod
color interpolation method.Only known color spaces are allowed as part of a color interpolation method.
-
If
space
is a PolarColorSpace:- Let
hue-arc
be theHueInterpolationMethod
specified inmethod
, orshorter
if no hue interpolation is specified.
- Let
-
Set
color1
andcolor2
respectively to the results of convertingcolor1
andcolor2
intospace
. -
For each
color
incolor1
andcolor2
:-
If any non-
alpha
component
ofcolor
isnone
, set thatcomponent
to the value of the corresponding component in the other color.If both values are
none
, the interpolation result for that component will also benone
. -
Set
color
to the result of premultiplyingcolor
. -
If
color
'salpha
component isnone
, set it to the value of thealpha
component in the other color.This is resolved after premultiplying, because premultiplying has special handling for a missing
alpha
component.
-
-
Let
mix
be a new color in the color spacespace
, withnone
for all channel and alpha values. -
For each
channel
ofmix
:-
Let
channel1
andchannel2
be the corresponding channel values incolor1
andcolor2
respectively. -
If
channel
has a polar angle value, setchannel1
andchannel2
respectively to the results of hue interpolation withchannel1
ashue1
,channel2
ashue2
, using thehue-arc
method. -
Set
channel
to the result of calculating(channel1 * weight) + (channel2 * (1 - weight))
.Channel rounding has been removed, since it is a lossy transform.
-
-
Set
mix
the result of un-premultiplyingmix
. -
Return the result of converting
mix
intoorigin-space
.
Premultiply Transparent Colors
When the colors being interpolated are not fully opaque, they are transformed
into premultiplied color values. This process accepts a single color
and
updates the channel values if necessary, returning a new color with
premultiplied channels.
-
If the
color
has analpha
value of 1 ornone
, returncolor
unchanged.It's not possible to premultiply channels relative to a missing alpha, and no multiplication is necessary with full opacity.
-
Otherwise, for each
channel
incolor
:-
If the
channel
value isnone
, or ifchannel
is a polar-anglehue
, keep the original value ofchannel
. -
Otherwise, set
channel
to the result of multiplying thechannel
value by thealpha
value.
-
-
Return the resulting
color
with premultiplied channels.
The same process can be run in reverse, to un-premultiply the channels of a
given color
:
-
If
color
has analpha
value of 1, 0, ornone
, returncolor
unchanged. -
Otherwise, for each
channel
incolor
:-
If the
channel
value isnone
, or ifchannel
is a polar-anglehue
, keep the original value ofchannel
. -
Otherwise, set
channel
to the result of dividing the premultipliedchannel
value by thealpha
value.
-
-
Return the resulting
color
with un-premultiplied channels.
Hue Interpolation
When interpolating between polar-angle hue channels, there are multiple 'directions' the interpolation could move, following different logical rules.
This process accepts two hue angles (hue1
and hue2
), and returns both hues
adjusted according to the given method
. When no hue interpolation method
is
specified, the default is shorter
.
The process for each hue interpolation method is defined in CSS Color Level 4.
Scaling a Number
This algorithm takes a number number
, a value factor
, a number max
, and
an optional number min
. It's written "scale <number>
by <factor>
with a
max
of <max>
and a min
of <min>
". It returns a number with a value
between min
(or 0) and max
and the same units as number
.
Note that this no longer assumes the original
number
is in a range of 0 tomax
. We now allow scaling up negative numbers, and scaling down numbers above themax
value. The inverse operations return thenumber
unchanged, since that's the asymptotic scale behavior approaching boundaries.
-
If
factor
isn't a number with unit%
between-100%
and100%
(inclusive), throw an error. -
If
min
is not specified, setmin
to 0. -
If
factor > 0%
:-
If
number > max
, returnnumber
. -
Otherwise, return
number + (max - number) * factor / 100%
.
-
-
Otherwise:
-
If
number < 0
, returnnumber
. -
Otherwise, return
number + (number - min) * factor / 100%
.
-
New Color Module Functions
These new functions are part of the built-in sass:color
module.
color.space()
space($color)
-
If
$color
is not a color, throw an error. -
Return an unquoted string with the name of
$color
s color space.
color.to-space()
to-space($color, $space)
-
If
$color
is not a color, throw an error. -
Let
known-space
be the result of looking up a known color space named$space
. -
Let
known-origin
be$color
's space. -
If
known-origin == known-space
, return$color
. -
Let
converted
be the result of converting theorigin-color
$color
to thetarget-space
known-space
. -
If
converted
is a legacy color:- For each
component
in the channels and alpha value ofconverted
, ifcomponent
is missing, setcomponent
to0
.
- For each
-
Return
converted
.
color.is-legacy()
is-legacy($color)
-
If
$color
is not a color, throw an error. -
Return
true
if$color
is a legacy color, orfalse
otherwise.
color.is-powerless()
is-powerless($color, $channel, $space: null)
-
If
$color
is not a color, throw an error. -
If
$channel
is not a quoted string, throw an error. -
If
$space
is null:-
Let
color
be$color
-
Let
origin-space
be the result of callingcolor.space($color)
. -
Let
space
be the result of looking up a known color space namedorigin-space
.
-
-
Otherwise:
-
Let
color
be the result of callingcolor.to-space($color, $space)
. -
Let
space
be the result of looking up a known color space named$space
.
-
-
Let
channels
be a list of thecolor
's channels. -
If
$channel
is not the name of a channel inchannels
, throw an error. -
Return
true
if the channel$channel
is powerless incolor
, otherwise returnfalse
.
color.is-in-gamut()
is-in-gamut($color, $space: null)
-
If
$color
is not a color, throw an error. -
Let
space-name
be the result of callingcolor.space($color)
if$space
is null, and the value of$space
otherwise. -
Let
space
be the result of looking up a known color space namedspace-name
. -
Let
color
be the result of callingcolor.to-space($color, space)
. -
For all bounded channels in
space
, if the associated channel value in$color
is fuzzy greater-than the bounded maximum, or fuzzy less-than the bounded minimum, returnfalse
. -
Otherwise, return
true
.
color.to-gamut()
to-gamut($color, $space: null)
-
If
$color
is not a color, throw an error. -
If
$space
is null:-
Let
origin-space
be the result of callingcolor.space($color)
. -
Let
target-space
be the result of looking up a known color space namedorigin-space
.
-
-
Otherwise, let
target-space
be the result of looking up a known color space named$space
. -
Return the result of gamut mapping
$color
with atarget-space
destination.
color.channel()
Note that channel values are stored as specified, even if those values are out-of-gamut for the known color space used. Similarly, this color-channel inspection function may return out-of-gamut channel values.
channel($color, $channel, $space: null)
-
If
$color
is not a color, throw an error. -
If
$channel
is not a quoted string, throw an error. -
If
$channel == 'alpha'
(ignoring case), letvalue
be the alpha value of$color
. -
Otherwise:
-
Let
color
be$color
if$space
is null, and the result of callingcolor.to-space($color, $space)
otherwise. -
Let
channel
be the channel incolor
's space named$channel
. Throw an error if no such channel exists. -
Let
value
bechannel
's value incolor
, or0
if the channel's value is missing. -
Let
unit
be the unit associated withchannel
incolor
's space, if defined, andnull
otherwise.
-
-
If
unit
is%
, returnvalue * 100
divided by the maximum ofchannel
's gamut range with unit%
. -
Otherwise, if
unit
is not null, returnvalue
with unitunit
. -
Otherwise, return
value
as a unitless number.
color.is-missing()
is-missing($color, $channel)
-
If
$color
is not a color, throw an error. -
If
$channel
is not a quoted string, throw an error. -
If
$channel == alpha
(ignoring case), letvalue
be the alpha value of$color
. -
Otherwise:
-
If
channel
is not the name of a channel in$color
, throw an error. -
Let
value
be the channel value namedchannel
incolor
.
-
-
Return
true
ifvalue == null
, andfalse
otherwise.
color.same()
While it's already possible to compare the equality of two colors, the result is always false when the two colors are in different color spaces. This function compares colors across color spaces, to determine if they are equal after being converted into the same space.
same($color1, $color2)
-
If either
$color1
or$color2
is not a color in a known color space:- Let
color1
be$color1
, and letcolor2
be$color2
.
We can compare, but we can't do conversion. The color space remains relevant to equality. While this is technically the same as using
==
, it makes the function more robust to allow comparison of all colors. - Let
-
Otherwise:
- Let
color1
andcolor2
be the result of converting$color1
and$color2
intoxyz
color space, respectively.
- Let
-
Return
color1 == color2
.
Modified Color Module Functions
color.hwb()
These functions are now deprecated. Authors should use global hwb()
instead.
-
hwb($channels)
- Return the result of calling the global function
hwb($channels)
.
- Return the result of calling the global function
-
hwb($hue, $whiteness, $blackness, $alpha: 1)
- Return the result of calling the global function
hwb(list.slash($hue $whiteness $blackness, $alpha))
.
- Return the result of calling the global function
color.mix()
mix($color1, $color2,
$weight: 50%,
$method: null)
-
If either
$color1
or$color2
is not a color, throw an error. -
If
$method
is null:-
If either
$color1
or$color2
is not a legacy color, throw an error.Method is required for non-legacy colors. This matches the
color-mix()
function defined in Colors Level 5, and allows us to add additional default behavior in the future. -
Return the result of legacy interpolation between
$color1
and$color2
with the specified$weight
.
-
-
Otherwise, if
$method
is not a color interpolation method, throw an error. -
Return the result of interpolating between
$color1
and$color2
with the specified$weight
and$method
.
color.change()
change($color, $args...)
This function is also available as a global function named change-color()
.
-
If
$color
is not a color, throw an error. -
If any item in
$args
is not a keyword argument, throw an error. -
Let
color
be the value of$color
. -
Let
origin-space
becolor
's space. -
If the keyword argument
$space
is specified in$args
:-
Let
known-space
be the result looking up a known color space named$space
. -
If
space != origin-space
, setcolor
to the result of callingcolor.to-space(color, space)
.
-
-
Otherwise, let
known-space
beorigin-space
. -
Let
alpha
becolor
's alpha property. -
If the keyword argument
$alpha
is specified in$args
:- Set
alpha
to the result of percent-converting$alpha
with amax
of 1, and clamping it between 0 and 1 (inclusive).
- Set
-
Let
channel-args
be the remaining keyword arguments in$args
, not including$space
or$alpha
arguments. -
Let
channels
be a list of thecolor
's channels. -
For each keyword
key
and valuenew
inchannel-args
:-
If
new
is not a number or an unquoted string that's case-insensitively equal to 'none', throw an error.This basic restriction can be applied to all spaces. Further channel restrictions are enforced by the normalization step for known spaces.
-
If
key
is not the name of a channel inchannels
:-
If
$space
is specified, throw an error. -
If
color
is not a legacy color, throw an error. -
If
key
is one ofred
,green
, orblue
, setspace
torgb
. -
Otherwise, if
key
is one ofsaturation
orlightness
, or ifkey
ishue
and the only other keywords inchannel-args
aresaturation
orlightness
, setspace
tohsl
. -
Otherwise, if
key
is one ofwhiteness
orblackness
, or ifkey
ishue
and the only other keywords inchannel-args
arewhiteness
orblackness
, setspace
tohwb
. -
Otherwise, throw an error.
-
Set
channels
to be a list of the channels incolor
converted tospace
.
-
-
Set the corresponding
key
value inchannels
tonew
.
-
-
Set
channels
to the result of normalizingchannels
inknown-space
. -
Let
new
be a color in color spaceknown-space
, withchannels
channels, and an alpha ofalpha
. -
Return the result of converting
new
intoorigin-space
.
color.adjust()
adjust($color, $args...)
This function is also available as a global function named adjust-color()
.
-
If
$color
is not a color, throw an error. -
If any item in
$args
is not a keyword argument, throw an error. -
Let
color
be the value of$color
. -
Let
origin-space
becolor
's space. -
If the keyword argument
$space
is specified in$args
:-
Let
known-space
be the result looking up a known color space named$space
. -
If
space != origin-space
, setcolor
to the result of callingcolor.to-space(color, space)
.
-
-
Otherwise, let
known-space
beorigin-space
. -
Let
alpha
becolor
's alpha property. -
If the keyword argument
$alpha
is specified in$args
:-
If
alpha == none
, throw an error.This is not the ideal solution for handling
none
, but we want to match CSS relative color syntax if possible. Throwing an error for now means we can adjust to match the CSS behavior once it is defined. -
Let
new-alpha
be the result of percent-converting$alpha
with amax
of 1. -
Set
alpha
to the value ofnew-alpha + alpha
clamped between 0 and 1.
-
-
Let
channel-args
be the remaining keyword arguments in$args
, not including$space
or$alpha
arguments. -
Let
channels
be a list of thecolor
's channels. -
For each keyword
key
and valueadjust
inchannel-args
:-
If
key
is not the name of a channel inchannels
:-
If
$space
is specified, throw an error. -
If
color
is not a legacy color, throw an error. -
If
key
is one ofred
,green
, orblue
, setspace
torgb
. -
Otherwise, if
key
is one ofsaturation
orlightness
, or ifkey
ishue
and the only other keywords inchannel-args
aresaturation
orlightness
, setspace
tohsl
. -
Otherwise, if
key
is one ofwhiteness
orblackness
, or ifkey
ishue
and the only other keywords inchannel-args
arewhiteness
orblackness
, setspace
tohwb
. -
Otherwise, throw an error.
-
Set
channels
to be a list of the channels incolor
converted tospace
.
-
-
Let
value
be the value of the channel namedkey
inchannels
. -
Let
original
bevalue
. -
Let
channel
be the channel namedkey
inknown-space
. -
If
channel == none
, throw an error.This is not the ideal solution for handling
none
, but we want to match CSS relative color syntax if possible. Throwing an error for now means we can adjust to match the CSS behavior once it is defined. -
If
adjust
has the unit%
:-
If
channel
requires a percentage, setvalue
to the result of appending%
units tovalue
. -
Otherwise, if
channel
allows percentage mapping, setadjust
to the result of percent-convertingadjust
with amax
given by the maximum ofchannel
's gamut range. -
Otherwise, throw an error.
-
-
Set
value
tovalue + adjust
.Once percentage/number conversions have been normalized, this will throw an error if
adjust
andvalue
are not compatible. -
If
channel
's upper boundbound
is clamped andvalue > bound
:-
If
original > bound
, setvalue
tomath.min(original, value)
. -
Otherwise, set
value
tobound
.
-
-
Otherwise, if
channel
's lower boundbound
is clamped andvalue < bound
:-
If
original < bound
, setvalue
tomath.max(original, value)
. -
Otherwise, set
value
tobound
.
-
This ensures that adjustment won't ever make a color go out-of-bounds, which preserves the historical clamping behavior (which is particularly important because negative saturation behaves very strangely) while still ensuring that adjustment works rationally for channels that are already out-of-bounds.
-
-
Set
channels
to the result of normalizingchannels
inknown-space
. -
Let
new
be a color in color spaceknown-space
, withchannels
channels, and an alpha ofalpha
. -
Return the result of converting
new
intoorigin-space
.
color.scale()
scale($color, $args...)
This function is also available as a global function named scale-color()
.
-
If
$color
is not a color, throw an error. -
If any item in
$args
is not a keyword argument, throw an error. -
Let
origin-space
be$color
's color space. -
If the keyword argument
$space
is specified in$args
:-
Let
space
be the result of looking up a known color space named$space
. -
Let
color
be the result of converting$color
tospace
.
-
-
Otherwise:
-
Let
space
beorigin-space
. -
Let
color
be the value of$color
.
-
-
Let
alpha
becolor
's alpha property. -
If the keyword argument
$alpha
is specified in$args
:-
If
alpha == none
, throw an error.This is not the ideal solution for handling
none
, but we want to match CSS relative color syntax if possible. Throwing an error for now means we can adjust to match the CSS behavior once it is defined. -
Set
alpha
to the result of scalingalpha
by$alpha
withmax
1.
-
-
Let
channel-args
be the remaining keyword arguments in$args
, not including$space
or$alpha
arguments. -
Let
channels
be a list of thecolor
's channels. -
For each keyword
scale
,factor
inchannel-args
:-
If
scale
is not the name of a scalable channel inchannels
:-
If
$space
is specified, throw an error. -
If
color
is not a legacy color, throw an error. -
If
scale
is one ofred
,green
, orblue
, setspace
torgb
. -
Otherwise, if
scale
is one ofsaturation
, orlightness
, setspace
tohsl
. -
Otherwise, if
scale
is one ofwhiteness
, orblackness
, setspace
tohwb
. -
Otherwise, throw an error.
-
Set
channels
to be a list oflegacy-color
's channels.
-
-
Let
channel
be the correspondingchannel
inchannels
with a name matchingscale
. -
If
channel == none
, throw an error.This is not the ideal solution for handling
none
, but we want to match CSS relative color syntax if possible. Throwing an error for now means we can adjust to match the CSS behavior once it is defined. -
Let
channel-max
be the upper boundary ofchannel
inspace
. -
Let
channel-min
be the lower boundary ofchannel
inspace
. -
Set the corresponding
channel
inchannels
to the result of scalingchannel
byfactor
with amax
ofchannel-max
and amin
ofchannel-min
.
-
-
Set
channels
be the result of normalizingchannels
inspace
. -
Let
new
be a color in color spacespace
, withchannels
channels, and an alpha ofalpha
. -
Return the result of converting
new
intoorigin-space
.
color.complement()
complement($color, $space: null)
This function is also available as a global function named complement()
.
-
If
$color
is not a color, throw an error. -
If
$space
is null:-
If
$color
is a legacy color, letspace
be the known color space namedhsl
. -
Otherwise, throw an error.
-
-
Otherwise:
-
Let
space
be the result of looking up a known color space named$space
. -
If
space
is not a known color space with a polar-angle hue channel, throw an error.This currently allows
hsl
,hwb
,lch
, andoklch
. We may decide to provide additional options in the future.
-
-
Return the result of calling
color.adjust($color, $hue: 180deg, $space: space)
.
color.invert()
invert($color,
$weight: 100%,
$space: null)
This function is also available as a global function named invert()
.
-
If
$color
is not a color, throw an error. -
If
$space
is null:-
If
$color
is a legacy color, letspace
bergb
, and letmix-space
be null.This allows us to also enforce legacy behavior in the final weighted mix.
-
Otherwise, throw an error.
-
-
Otherwise:
-
Let
space
be the result of looking up a known color space named$space
. -
If
space
is not a known color space, throw an error. -
Let
mix-space
bespace
.
-
-
If
$weight == 0%
, return the value of$color
. -
If
space
is not a valid color interpolation method interpolation color space, and$weight != 100%
, throw an error. -
Let
color
be the result of converting$color
intospace
. -
If
space
is the known color space namedhwb
:-
Let
hue
,white
, andblack
be the three elements ofcolor
's channels. -
Let
hue-out
be the result of(hue + 180deg) % 360deg
. -
Let
invert
be the result of callingcolor.change(color, $hue: hue-out, $white: black, $black: white)
.
-
-
Otherwise:
-
Let
invert
be the value ofcolor
. -
For each
channel
element incolor
's channels:-
If
channel
is a polar-anglehue
:- Let
new
be(channel + 180deg) % 360deg
.
- Let
-
Otherwise, if
channel
's name is eitherchroma
orsaturation
:- Let
new
bechannel
.
- Let
-
Otherwise:
-
Let
min
andmax
be the minimum and maximum values defined forchannel
inspace
. -
Let
new
bemax - channel
ifmin == 0
, andchannel * -1
otherwise.
-
-
Set the corresponding channel of
invert
to benew
.
-
-
-
If
$weight == 100%
, return the value ofinvert
. -
Return the result of calling
color.mix(invert, color, $weight, mix-space)
.
color.grayscale()
grayscale($color)
No space argument is provided, since the results should always be in gamut.
This function is also available as a global function named grayscale()
.
-
If
$color
is not a color, throw an error. -
If
$color
is a legacy color:- Return the result of converting
$color
tohsl
, and changing the 'saturation' channel to 0.
- Return the result of converting
-
Otherwise:
-
Let
origin
be$color
's color space. -
Let
color
be the result of converting$color
tooklch
, and setting thechroma
channel to 0. -
Return the result of converting
color
toorigin
.
-
color.ie-hex-str()
This function is also available as a global function named ie-hex-str()
. Both
functions are deprecated.
ie-hex-str($color)
-
If
$color
is not a color, throw an error. -
Let
rgb
be the result of converting and gamut mapping$color
torgb
. -
Let
hex-list
be an empty list. -
For each
channel
inrgba
's channels, as numbers:-
Let
hex-channel
be the hexadecimal representation ofchannel
's value. -
Append
hex-channel
as the next item inhex-list
.
-
-
Let
alpha
bergb
's alpha value. -
Let
hex-alpha
be the hexadecimal representation ofalpha * 255
. -
Append
hex-alpha
as the next item inhex-list
. -
Return the result of concatenating
hex-list
into a string.
New Global Functions
These new CSS functions are provided globally.
hwb()
-
hwb($channels)
-
Let
parsed
be the result of parsing$channels
inhwb
space.Normalization and clamping is handled as part of the parsing process.
-
If
parsed
is a string, return a plain CSS function string with the name"hwb"
and the argumentparsed
. -
Let
channels
be the channel list, andalpha
the alpha value ofparsed
. -
Let
hue
,whiteness
, andblackness
be the three elements ofchannels
. -
Return a legacy color in the
hwb
space, with the givenhue
,whiteness
, andblackness
channels, andalpha
value.
-
lab()
-
lab($channels)
-
Let
parsed
be the result of parsing$channels
inlab
space. -
If
parsed
is a string, return a plain CSS function string with the name"lab"
and the argumentparsed
. -
Let
channels
be the channel list, andalpha
the alpha value ofparsed
. -
Let
lightness
,a
, andb
be the three elements ofchannels
. -
Return a color in the
lab
known color space, with the givenlightness
,a
, andb
channels, andalpha
value.
-
lch()
-
lch($channels)
-
Let
parsed
be the result of parsing$channels
inlch
space. -
If
parsed
is a string, return a plain CSS function string with the name"lch"
and the argumentparsed
. -
Let
channels
be the channel list, andalpha
the alpha value ofparsed
. -
Let
lightness
,chroma
, andhue
be the three elements ofchannels
. -
Return a color in the
lch
known color space, with the givenlightness
,chroma
, andhue
channels, andalpha
value.
-
oklab()
-
oklab($channels)
-
Let
parsed
be the result of parsing$channels
inoklab
space. -
If
parsed
is a string, return a plain CSS function string with the name"oklab"
and the argumentparsed
. -
Let
channels
be the channel list, andalpha
the alpha value ofparsed
. -
Let
lightness
,a
, andb
be the three elements ofchannels
. -
Return a color in the
oklab
known color space, with the givenlightness
,a
, andb
channels, andalpha
value.
-
oklch()
-
oklch($channels)
-
Let
parsed
be the result of parsing$channels
inoklch
space. -
If
parsed
is a string, return a plain CSS function string with the name"oklch"
and the argumentparsed
. -
Let
channels
be the channel list, andalpha
the alpha value ofparsed
. -
Let
lightness
,chroma
, andhue
be the three elements ofchannels
. -
Return a color in the
oklch
known color space, with the givenlightness
,chroma
, andhue
channels, andalpha
value.
-
color()
-
color($description)
-
Let
parsed
be the result of parsing$description
without a space. -
If
parsed
is a string, return a plain CSS function string with the name"color"
and the argumentparsed
. -
Let
space
be the color space,channels
the channel list, andalpha
the alpha value ofparsed
. -
Return a color in
space
, with the givenchannels
andalpha
value.
-
Modified Global Functions
Any legacy global functions that are not explicitly updated here should continue to behave as alias functions for their appropriately updated counterparts.
Note that the new logic preserves decimal values in color channels, as well as preserving the initial color-space used in defining a color.
rgb()
and rgba()
The rgba()
function is identical to rgb()
, except that if it would return a
plain CSS function named "rgb"
that function is named "rgba"
instead.
-
rgb($red, $green, $blue, $alpha: 1)
-
If any argument is an unquoted string that's case-insensitively equal to 'none', throw an error.
Missing channels are not allowed in legacy syntax.
-
If any argument is a special number, return a plain CSS function string with the name
"rgb"
and the arguments$red
,$green
,$blue
, and$alpha
. -
If
$alpha
is not a number, throw an error. -
Let
alpha
be the result of percent-convertingalpha
with a max of 1, and then clamping the value between 0 and 1, inclusive. -
Let
red
,green
, andblue
be the three elements returned by normalizing($red, $green, $blue)
in the known color space namedrgb
. -
Return a legacy color in the
rgb
space, with the givenred
,green
, andblue
channels, andalpha
value.
-
-
rgb($red, $green, $blue)
-
If any argument is a special number, return a plain CSS function string with the name
"rgb"
and the arguments$red
,$green
, and$blue
. -
Otherwise, return the result of calling
rgb($red, $green, $blue, 1)
.
-
-
rgb($channels)
-
Let
parsed
be the result of parsing$channels
inrgb
space. -
If
parsed
is a string, return a plain CSS function string with the name"rgb"
and the argumentparsed
. -
Let
channels
be the channel list, andalpha
the alpha value ofparsed
. -
Let
red
,green
, andblue
be the three elements ofchannels
. -
Return the result of calling
rgb(red, green, blue, alpha)
.
-
-
rgb($color, $alpha)
-
If either argument is a special variable string, return a plain CSS function string with the name
"rgb"
and the same arguments. -
If
$color
is not a legacy color, throw an error. -
Return the result of calling
rgb()
with$color
's red, green, and blue channels as unitless number arguments, and$alpha
as the final argument.
-
hsl()
and hsla()
The hsla()
function is identical to hsl()
, except that if it would return a
plain CSS function named "hsl"
that function is named "hsla"
instead.
-
hsl($hue, $saturation, $lightness, $alpha: 1)
-
If any argument is an unquoted string that's case-insensitively equal to 'none', throw an error.
Missing channels are not allowed in legacy syntax.
-
If any argument is a special number, return a plain CSS function string with the name
"hsl"
and the arguments$hue
,$saturation
,$lightness
, and$alpha
. -
If
$alpha
is not a number, throw an error. -
Let
alpha
be the result of percent-convertingalpha
with a max of 1, and then clamping the value between 0 and 1, inclusive. -
Let
hue
,saturation
, andlightness
be the three elements returned by normalizing($hue, $saturation, $lightness)
in the known color space namedhsl
.
Conversion to rgb has been removed.
- Return a legacy color in the
hsl
space, with the givenhue
,saturation
, andlightness
channels, andalpha
value.
-
-
hsl($hue, $saturation, $lightness)
-
If any argument is a special number, return a plain CSS function string with the name
"hsl"
and the arguments$hue
,$saturation
, and$lightness
. -
Otherwise, return the result of calling
hsl($hue, $saturation, $lightness, 1)
.
-
-
hsl($hue, $saturation)
-
If either argument is a special variable string, return a plain CSS function string with the name
"hsl"
and the same arguments. -
Otherwise, throw an error.
-
-
hsl($channels)
-
Let
parsed
be the result of parsing$channels
inhsl
space.Normalization and clamping is handled as part of the parsing process.
-
If
parsed
is a string, return a plain CSS function string with the name"hsl"
and the argumentparsed
. -
Let
channels
be the channel list, andalpha
the alpha value ofparsed
. -
Let
hue
,saturation
, andlightness
be the three elements ofchannels
. -
Return a legacy color in the
hsl
space, with the givenhue
,saturation
, andlightness
channels, andalpha
value.
-
Deprecated Functions
Individual color-channel functions defined globally or in the color module are
deprecated in favor of the new color.channel()
function. Legacy global color
functions are also deprecated. These functions always throw errors. During
the deprecation process, they act as alias functions described below.
color.red()
, red()
-
color.red($color)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.channel($color, 'red', rgb)
.
-
This function is also available as a global function named red()
.
color.green()
, green()
-
color.green($color)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.channel($color, 'green', rgb)
.
-
This function is also available as a global function named green()
.
color.blue()
, blue()
-
color.blue($color)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.channel($color, 'blue', rgb)
.
-
This function is also available as a global function named blue()
.
color.hue()
, hue()
-
color.hue($color)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.channel($color, 'hue', hsl)
.
-
This function is also available as a global function named hue()
.
color.saturation()
, saturation()
-
color.saturation($color)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.channel($color, 'saturation', hsl)
.
-
This function is also available as a global function named saturation()
.
color.lightness()
, lightness()
-
color.lightness($color)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.channel($color, 'lightness', hsl)
.
-
This function is also available as a global function named lightness()
.
color.whiteness()
-
color.whiteness($color)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.channel($color, 'whiteness', hwb)
.
-
color.blackness()
-
color.blackness($color)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.channel($color, 'blackness', hwb)
.
-
color.alpha()
-
color.alpha($color)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.channel($color, 'alpha')
.
-
adjust-hue()
-
adjust-hue($color, $amount)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.adjust($color, $hue: $amount, $space: hsl)
.
-
saturate()
-
saturate($color, $amount)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.adjust($color, $saturation: $amount, $space: hsl)
.
-
desaturate()
-
desaturate($color, $amount)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.adjust($color, $saturation: -$amount, $space: hsl)
.
-
transparentize()
, fade-out()
-
transparentize($color, $amount)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.adjust($color, $alpha: -$amount)
.
-
This function is also available as a global function named fade-out()
.
opacify()
, fade-in()
-
opacify($color, $amount)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.adjust($color, $alpha: $amount)
.
-
This function is also available as a global function named fade-in()
.
lighten()
-
lighten($color, $amount)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.adjust($color, $lightness: $amount, $space: hsl)
.
-
darken()
-
darken($color, $amount)
-
If
$color
is not a legacy color, throw an error. -
Return the result of calling
color.adjust($color, $lightness: -$amount, $space: hsl)
.
-