sass-apca 1.0.4 → 1.1.0

package/README.md

@@ -27,7 +27,30 @@ $contrast-black-on-white: apca.contrast(black, white); // 106.0406668287
 $contrast-white-on-black: apca.contrast(white, black); // -107.8847261151
 ```
 
-## About
+### Text color recommendation
+Checks a light and a dark text color against a given background and returns the text color with the best contrast.
+
+| Parameter | Type | Default | Description |
+|:--- |:--- |:--- |:--- |
+| $backgroundColor | [Sass color]() | | The background color to check against |
+| $lightColor | [Sass color]() | white | [optional] A light text color |
+| $darkColor | [Sass color]() | black | [optional] A dark text color |
+
+```scss
+@use 'sass-apca/apca';
+
+body {
+  background-color: #ccc;
+
+  // either white or black text color
+  color: apca.recommend-text-color(#ccc); // white
+
+  // with custom light and dark text colors
+  color: apca.recommend-text-color(#ccc, #eee, #111); // #111
+}
+```
+
+## About contrast levels
 These general levels are appropriate for use by themselves, without the need to reference a lookup table. APCA reports contrast as an L<sup>c</sup> value (lightness contrast) from L<sup>c</sup> 0 to L<sup>c</sup> 105+. For accessibility, consider L<sup>c</sup> 15 the point of invisibility for many users, and L<sup>c</sup> 90 is preferred for body text. [^2]
 
 - **L<sup>c</sup> 90** • Preferred level for fluent text and columns of body text with a font no smaller than 14px/weight 400 (normal).

package/apca.scss

@@ -90,3 +90,56 @@ $_blueMultiplier: 0.072175;
     @return ($polarity + $_Woffset) * 100;
   }
 }
+
+/**
+ * Compares contrasts of light or dark text against a given background and recommends
+ * usage of the text color with the best contrast.
+ *
+ * @param   {color}  $backgroundColor  Background color
+ * @param   {color}  $lightColor       [optional] Preferred light color, default is white
+ * @param   {color}  $darkColor        [optional] Preferred dark color, default is black
+ *
+ * @return  {color}                    Light or dark text color, whichever provides the better contrast against the chosen background
+ */
+@function recommend-text-color($backgroundColor, $lightColor: white, $darkColor: black) {
+  @if (meta.type-of($backgroundColor) != 'color') {
+    @error "Type Error: apca.recommend-text-color expects a color as first argument but received #{meta.type-of($backgroundColor)}. Please provide a valid color.";
+  }
+
+  @if (meta.type-of($lightColor) != 'color') {
+    @error "Type Error: apca.recommend-text-color expects a color as second argument but received #{meta.type-of($lightColor)}. Please provide a valid color.";
+  }
+
+  @if (meta.type-of($backgroundColor) != 'color') {
+    @error "Type Error: apca.recommend-text-color expects a color as third argument but received #{meta.type-of($darkColor)}. Please provide a valid color.";
+  }
+  
+  $lightContrast: math.abs(contrast($lightColor, $backgroundColor));
+  $darkContrast: math.abs(contrast($darkColor, $backgroundColor));
+  $contrastColor: null;
+  $bestContrast: null;
+
+  @if ($darkContrast > $lightContrast) {
+    $contrastColor: $darkColor;
+    $bestContrast: $darkContrast;
+  } @else {
+    $contrastColor: $lightColor;
+    $bestContrast: $lightContrast
+  }
+
+  @if ($bestContrast < 15) {
+    @warn "Your best contrast is #{$bestContrast}. This is lower than 15, the absolute minimum for any non-text that needs to be discernible and differentiable, and is no less than 6px in its smallest dimension. This may include disabled large buttons. Designers should treat anything below this level as invisible, as it will not be visible for many users. This minimum level should be avoided for any items important to the use, understanding, or interaction of the site.";
+  } @else if ($bestContrast < 30) {
+    @warn "Your best contrast is #{$bestContrast}. This is lower than 30, the absolute minimum for any text not listed above. This includes placeholder text and disabled element text. This is also the minimum for large/solid semantic & understandable non-text elements.";
+  } @else if ($bestContrast < 45) {
+    @warn "Your best contrast is #{$bestContrast}. This is lower than 45, the minimum for larger, heavier text (36px normal weight or 24px bold) such as headlines. This is also the minimum for pictograms with fine details.";
+  } @else if ($bestContrast < 60) {
+    @warn "Your best contrast is #{$bestContrast}. This is lower than 60, the minimum level recommended for content text that is not body, column, or block text. In other words, text you want people to read. The minimums: 24px normal weight (400) or 16px/700 (bold). These values based on the reference font Helvetica.";
+  } @else if ($bestContrast < 75) {
+    @warn "Your best contrast is #{$bestContrast}. This is lower than 75, the minimum level for columns of body text with a font no smaller than 18px/400. Lc 75 should be considered a minimum for text where readability is important.";
+  } @else if ($bestContrast < 90) {
+    @warn "Your best contrast is #{$bestContrast}. This is lower than 90, the preferred level for fluent text and columns of body text with a font no smaller than 14px/weight 400 (normal).";
+  }
+
+  @return $contrastColor;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sass-apca",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "Sass implementation of the [Accessible Perceptual Contrast Algorithm (APCA)](https://git.apcacontrast.com/) for the WCAG 3.0 specification.",
   "keywords": [
     "sass",