Interface Palette

A collection of PaletteColor objects.

interface Palette {
    COLORS: PaletteColor[];
    CONTRAST_MAP?: {
        #000000: string[];
        #FFFFFF: string[];
        [HEX: string]: string[];
    };
    DISCRIMINATOR: PALETTE;
    IS_GRADIENT: boolean;
    NAME: string;
    SOURCE?: string;
}

Properties

COLORS CONTRAST_MAP? DISCRIMINATOR IS_GRADIENT NAME SOURCE?

Properties

ReadonlyCOLORS

COLORS: PaletteColor[]

The list of PaletteColor objects that compose the palette.

Optional ReadonlyCONTRAST_MAP

CONTRAST_MAP?: {
    #000000: string[];
    #FFFFFF: string[];
    [HEX: string]: string[];
}

A map of hex color strings to arrays of hex colors, where each color in the array passes the WCAG AA standard with normal and large size text when compared to the key.
The only colors listed in this map should be the colors of the palette, black (#000000), and white (#FFFFFF).

Type declaration

  • [HEX: string]: string[]
  • Readonly#000000: string[]

    The colors in the palette that pass the WCAG AA standard when compared to black (#000000). This list should NOT contain white (#FFFFFF) unless it is a color listed in the palette.

  • Readonly#FFFFFF: string[]

    The colors in the palette that pass the WCAG AA standard when compared to white (#FFFFFF). This list should NOT contain black (#000000) unless it is a color listed in the palette.

ReadonlyDISCRIMINATOR

DISCRIMINATOR: PALETTE

Discriminator for determining if an object is a Palette.

ReadonlyIS_GRADIENT

IS_GRADIENT: boolean

A flag indicating if the palette is a gradient.

ReadonlyNAME

NAME: string

The name of the palette.

Optional ReadonlySOURCE

SOURCE?: string

The source of the palette. May be the URL where the palette can be found.

Settings

Member Visibility

On This Page

Properties