#14 #88 Add initial contrast map structure.

brittni-and-the-polar-bear · Jun 2, 2024 · 8d8e63e · 8d8e63e
1 parent 3d6b0a8
commit 8d8e63e
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/docs/release-notes/v0.6.0-notes.md b/docs/release-notes/v0.6.0-notes.md
@@ -232,7 +232,16 @@ declare interface Palette {
     /**
      * The list of {@link PaletteColor} objects that compose the palette.
      */
-    readonly COLORS: PaletteColor[]
+    readonly COLORS: PaletteColor[],
+
+    /**
+     * 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.<br/>
+     * The only colors listed in this map should be the colors of the
+     * palette, black (#000000), and white (#FFFFFF).
+     */
+    readonly CONTRAST_MAP: { [HEX: string]: string[] }
 }
 ```
 

diff --git a/src/main/color/palette/palette.ts b/src/main/color/palette/palette.ts
@@ -40,5 +40,14 @@ export interface Palette {
     /**
      * The list of {@link PaletteColor} objects that compose the palette.
      */
-    readonly COLORS: PaletteColor[]
+    readonly COLORS: PaletteColor[],
+
+    /**
+     * 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.<br/>
+     * The only colors listed in this map should be the colors of the
+     * palette, black (#000000), and white (#FFFFFF).
+     */
+    readonly CONTRAST_MAP: { [HEX: string]: string[] }
 }