@batpb/genart - v2.0.0-rc.3-alpha.2
    Preparing search index...

    Interface Palette

    A collection of PaletteColor objects.

    2.0.0

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

    Hierarchy (View Summary)

    Index

    Properties

    COLORS: PaletteColor[]

    The list of PaletteColor objects that compose the palette.

    2.0.0

    CONTRAST_MAP?: {
        "#000000": string[];
        "#FFFFFF": string[];
        readonly [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

    • readonly [HEX: string]: string[]

      The colors in the palette that pass the WCAG AA standard when compared to any other color in the palette.

      2.0.0

    • 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.

      2.0.0

    • 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.

      2.0.0

    2.0.0

    DISCRIMINATOR: PALETTE

    Discriminator value for the implementing interface.

    IS_GRADIENT: boolean

    A flag indicating if the palette is a gradient.

    2.0.0

    NAME: string

    The name of the palette.

    2.0.0

    SOURCE?: string

    The source of the palette.

    2.0.0

    SOURCE_URL?: string

    The source URL of the palette.

    2.0.0