#14 #88 Update documentation.

brittni-and-the-polar-bear · Jun 2, 2024 · 022c0e5 · 022c0e5
1 parent 83746ee
commit 022c0e5
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 6 deletions.
diff --git a/docs/release-notes/v0.6.0-notes.md b/docs/release-notes/v0.6.0-notes.md
@@ -242,8 +242,20 @@ declare interface Palette {
      * palette, black (#000000), and white (#FFFFFF).
      */
     readonly CONTRAST_MAP: {
+        /**
+         * 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.
+         */
         '#000000': 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.
+         */
         '#FFFFFF': string[],
+
         [HEX: string]: string[]
     },
 

diff --git a/src/main/color/palette/palette.ts b/src/main/color/palette/palette.ts
@@ -52,8 +52,20 @@ export interface Palette {
      * palette, black (#000000), and white (#FFFFFF).
      */
     readonly CONTRAST_MAP: {
+        /**
+         * 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.
+         */
         '#000000': 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.
+         */
         '#FFFFFF': string[],
+
         [HEX: string]: string[]
     },
 

diff --git a/src/test/shared/palette.ts b/src/test/shared/palette.ts
@@ -62,14 +62,20 @@ export function checkForPaletteNameKeyMatch(map: StringMap<Palette>): void {
 
 export function checkForValidContrastMap(palette: Palette): void {
     checkForValidPalette(palette);
-    expect(palette.CONTRAST_MAP['#000000']).not.toContain('#FFFFFF');
-    expect(palette.CONTRAST_MAP['#FFFFFF']).not.toContain('#000000');
 
     const validHexes: string[] = palette.COLORS.map((color: PaletteColor): string => {
        return color.HEX;
     });
-    validHexes.push('#000000');
-    validHexes.push('#FFFFFF');
+
+    if (validHexes.indexOf('#000000') < 0) {
+        expect(palette.CONTRAST_MAP['#FFFFFF']).not.toContain('#000000');
+        validHexes.push('#000000');
+    }
+
+    if (validHexes.indexOf('#FFFFFF') < 0) {
+        expect(palette.CONTRAST_MAP['#000000']).not.toContain('#FFFFFF');
+        validHexes.push('#FFFFFF');
+    }
 
     for (const key in palette.CONTRAST_MAP) {
         checkForValidHexColorString(key);
@@ -79,14 +85,21 @@ export function checkForValidContrastMap(palette: Palette): void {
             checkForValidHexColorString(hex);
             expect(validHexes).toContain(hex);
 
-            const meetsRatio: boolean =
+            const meetsNormalRatio: boolean =
                 ColorContrastAssessor.meetsContrastStandard(
                     key,
                     hex,
                     ContrastStandard.AA,
                     ContrastFontSize.NORMAL
                 );
-            expect(meetsRatio).toBeTruthy();
+            const meetsLargeRatio: boolean =
+                ColorContrastAssessor.meetsContrastStandard(
+                    key,
+                    hex,
+                    ContrastStandard.AA,
+                    ContrastFontSize.LARGE
+                );
+            expect(meetsNormalRatio && meetsLargeRatio).toBeTruthy();
         }
     }
 }