Class SassColor

Sass's color type.

No matter what representation was originally used to create this color, all of its channels are accessible.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new SassColor(options: { alpha?: number; blue: number; green: number; red: number }): SassColor

  • Creates an RGB color.

    throws

    Error if red, green, and blue aren't between 0 and 255, or if alpha isn't between 0 and 1.

    Parameters

    • options: { alpha?: number; blue: number; green: number; red: number }
      • Optional alpha?: number
      • blue: number
      • green: number
      • red: number

    Returns SassColor

constructor

  • new SassColor(options: { alpha?: number; hue: number; lightness: number; saturation: number }): SassColor

  • Creates an HSL color.

    throws

    Error if saturation or lightness aren't between 0 and 100, or if alpha isn't between 0 and 1.

    Parameters

    • options: { alpha?: number; hue: number; lightness: number; saturation: number }
      • Optional alpha?: number
      • hue: number
      • lightness: number
      • saturation: number

    Returns SassColor

constructor

  • new SassColor(options: { alpha?: number; blackness: number; hue: number; whiteness: number }): SassColor

  • Creates an HWB color.

    throws

    Error if whiteness or blackness aren't between 0 and 100, or if alpha isn't between 0 and 1.

    Parameters

    • options: { alpha?: number; blackness: number; hue: number; whiteness: number }
      • Optional alpha?: number
      • blackness: number
      • hue: number
      • whiteness: number

    Returns SassColor

Accessors

alpha

  • get alpha(): number

asList

  • get asList(): List<Value>

blackness

  • get blackness(): number

blue

  • get blue(): number

green

  • get green(): number

hasBrackets

  • 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

isTruthy

  • get isTruthy(): boolean

lightness

  • get lightness(): number

realNull

  • get realNull(): null | Value

red

  • get red(): number

saturation

  • get saturation(): number

separator

  • 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

Methods

assertBoolean

assertColor

assertFunction

assertMap

assertNumber

assertString

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 }
      • Optional alpha?: number
      • Optional blue?: number
      • Optional green?: number
      • Optional red?: 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 }
      • Optional alpha?: number
      • Optional hue?: number
      • Optional lightness?: number
      • Optional saturation?: 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 }
      • Optional alpha?: number
      • Optional blackness?: number
      • Optional hue?: number
      • Optional whiteness?: number

    Returns SassColor

equals

  • equals(other: Value): boolean

get

  • get(index: number): undefined | Value

  • Returns the value at index index in this value as a list, or undefined if index isn'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 immutable package: 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

hashCode

  • hashCode(): number

sassIndexToListIndex

  • sassIndexToListIndex(sassIndex: Value, name?: string): number

  • Converts sassIndex into 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

    Error If sassIndex isn'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.

    • Optional name: string

      The name of the function argument sassIndex came from (without the $) if it came from an argument. Used for error reporting.

    Returns number

tryMap