SassColor
Hierarchy
- Value
- SassColor
Index
Constructors
constructor
- new
Sass Color(options: {
alpha?: number;
blue: number;
green: number;
red: number;
}): SassColor -
Creates an RGB color.
Throws
Errorifred,green, andbluearen't between0and255, or ifalphaisn't between0and1.Parameters
-
options: {
alpha?: number;
blue: number;
green: number;
red: number;
}-
Optionalalpha?: number -
blue: number
-
green: number
-
red: number
-
Returns SassColor
-
constructor
- new
Sass Color(options: {
alpha?: number;
hue: number;
lightness: number;
saturation: number;
}): SassColor -
Creates an HSL color.
Throws
Errorifsaturationorlightnessaren't between0and100, or ifalphaisn't between0and1.Parameters
-
options: {
alpha?: number;
hue: number;
lightness: number;
saturation: number;
}-
Optionalalpha?: number -
hue: number
-
lightness: number
-
saturation: number
-
Returns SassColor
-
constructor
- new
Sass Color(options: {
alpha?: number;
blackness: number;
hue: number;
whiteness: number;
}): SassColor -
Creates an HWB color.
Throws
Errorifwhitenessorblacknessaren't between0and100, or ifalphaisn't between0and1.Parameters
-
options: {
alpha?: number;
blackness: number;
hue: number;
whiteness: number;
}-
Optionalalpha?: number -
blackness: number
-
hue: number
-
whiteness: number
-
Returns SassColor
-
Accessors
alpha
- get alpha(): number
-
This color's alpha channel, between
0and1.Returns number
as
- get asList(): List<Value>
-
This value as a list.
All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
Returns List<Value>
An immutable List from the
immutablepackage.
blackness
- get blackness(): number
-
This color's blackness, between
0and100.Returns number
blue
- get blue(): number
-
This color's blue channel, between
0and255.Returns number
green
- get green(): number
-
This color's green channel, between
0and255.Returns number
has
- get hasBrackets(): boolean
-
Whether this value as a list has brackets.
All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
Returns boolean
hue
- get hue(): number
-
This color's hue, between
0and360.Returns number
is
- get isTruthy(): boolean
-
Whether the value counts as
truein an@ifstatement and other contexts.Returns boolean
lightness
- get lightness(): number
-
This color's lightness, between
0and100.Returns number
real
red
- get red(): number
-
This color's red channel, between
0and255.Returns number
saturation
- get saturation(): number
-
This color's saturation, between
0and100.Returns number
separator
- get separator(): ListSeparator
-
The separator for this value as a list.
All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
Returns ListSeparator
whiteness
- get whiteness(): number
-
This color's whiteness, between
0and100.Returns number
Methods
assert
- assert
Boolean(name?: string): SassBoolean -
Throws if
thisisn't a SassBoolean.⚠️ Heads up!
Functions should generally use isTruthy rather than requiring a literal boolean.
Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassBoolean
-
assert
assert
- assert
Function(name?: string): SassFunction -
Throws if
thisisn't a SassFunction.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassFunction
-
assert
assert
- assert
Number(name?: string): SassNumber -
Throws if
thisisn't a SassNumber.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassNumber
-
assert
- assert
String(name?: string): SassString -
Throws if
thisisn't a SassString.Parameters
-
Optionalname: stringThe name of the function argument
thiscame from (without the$) if it came from an argument. Used for error reporting.
Returns SassString
-
change
- change(options: {
alpha?: number;
blue?: number;
green?: number;
red?: number;
}): SassColor -
Changes one or more of this color's RGB channels and returns the result.
Parameters
-
options: {
alpha?: number;
blue?: number;
green?: number;
red?: number;
}-
Optionalalpha?: number -
Optionalblue?: number -
Optionalgreen?: number -
Optionalred?: number
-
Returns SassColor
-
change
- change(options: {
alpha?: number;
hue?: number;
lightness?: number;
saturation?: number;
}): SassColor -
Changes one or more of this color's HSL channels and returns the result.
Parameters
-
options: {
alpha?: number;
hue?: number;
lightness?: number;
saturation?: number;
}-
Optionalalpha?: number -
Optionalhue?: number -
Optionallightness?: number -
Optionalsaturation?: number
-
Returns SassColor
-
change
- change(options: {
alpha?: number;
blackness?: number;
hue?: number;
whiteness?: number;
}): SassColor -
Changes one or more of this color's HWB channels and returns the result.
Parameters
-
options: {
alpha?: number;
blackness?: number;
hue?: number;
whiteness?: number;
}-
Optionalalpha?: number -
Optionalblackness?: number -
Optionalhue?: number -
Optionalwhiteness?: number
-
Returns SassColor
-
equals
get
- get(index: number): undefined | Value
-
Returns the value at index
indexin this value as a list, orundefinedifindexisn't valid for this list.All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.
This is a shorthand for
this.asList.get(index), although it may be more efficient in some cases.⚠️ Heads up!
This method uses the same indexing conventions as the
immutablepackage: unlike Sass the index of the first element is 0, but like Sass negative numbers index from the end of the list.Parameters
-
index: number
Returns undefined | Value
-
hash
sass
- sass
Index To List Index(sassIndex: Value, name?: string): number -
Converts
sassIndexinto a JavaScript-style index into the list returned by asList.Sass indexes are one-based, while JavaScript indexes are zero-based. Sass indexes may also be negative in order to index from the end of the list.
Throws
ErrorIfsassIndexisn't a number, if that number isn't an integer, or if that integer isn't a valid index for asList.Parameters
-
sassIndex: Value
The Sass-style index into this as a list.
-
Optionalname: stringThe name of the function argument
sassIndexcame from (without the$) if it came from an argument. Used for error reporting.
Returns number
-
Sass's color type.
No matter what representation was originally used to create this color, all of its channels are accessible.