Modified color2 to be optional in findContrast method

Author: elusivecodes

README.md

@@ -454,14 +454,18 @@ const distance = Color.dist(color1, color2);
 Find an optimally contrasting color for another color.
 
 - `color1` is a *Color* object.
-- `color2` is a *Color* object.
+- `color2` is a *Color* object, and will default to *null*.
 - `minContrast` is a number between *1* and *21* indicating the minimum valid contrast, and will default to *4.5*.
 - `stepSize` is a number between *0* and *1* indicating the amount to darken/lighten the color on each iteration, and will default to *0.01*.
 
 ```javascript
 const contrastColor = Color.findContrast(color1, color2, minContrast, stepSize);
 ```
 
+If `color2` value is *null*, a clone of `color1` will be used instead.
+
+This method will tint/shade `color2` until it meets a minimum contrast threshold with `color1`, then the new color will be returned. If no valid contrast value can be found, this method will return *null* instead.
+
 **Mix**
 
 Create a new *Color* by mixing two colors together by a specified amount.

dist/frost-color.js

@@ -1,5 +1,5 @@
 /**
- * FrostColor v2.0.5
+ * FrostColor v2.0.6
  * https://github.com/elusivecodes/FrostColor
  */
 (function(global, factory) {
@@ -944,31 +944,28 @@
         /**
          * Find an optimally contrasting color for another color.
          * @param {Color} color1 The first Color.
-         * @param {Color} color2 The second Color.
+         * @param {Color} [color2] The second Color.
          * @param {number} [minContrast=4.5] The minimum contrast.
          * @param {number} [stepSize=1] The step size.
          * @returns {Color} The new Color.
          */
-        findContrast(color1, color2, minContrast = 4.5, stepSize = 0.01) {
-            const tempColor = this.fromString(color2.toString());
-
-            if (this.contrast(color1, tempColor) >= minContrast) {
-                return tempColor;
+        findContrast(color1, color2 = null, minContrast = 4.5, stepSize = 0.01) {
+            if (!color2) {
+                color2 = color1.clone();
             }
 
-            let offset = stepSize;
-            while (offset <= 1) {
-                const tempColor1 = tempColor.clone().tint(offset);
-                if (this.contrast(color1, tempColor1) >= minContrast) {
-                    return tempColor1;
-                }
+            if (this.contrast(color1, color2) >= minContrast) {
+                return color2;
+            }
 
-                const tempColor2 = tempColor.clone().shade(offset);
-                if (this.contrast(color1, tempColor2) >= minContrast) {
-                    return tempColor2;
+            const methods = ['tint', 'shade'];
+            for (let i = stepSize; i <= 1; i += stepSize) {
+                for (const method of methods) {
+                    const tempColor = color2.clone()[method](i);
+                    if (this.contrast(color1, tempColor) >= minContrast) {
+                        return tempColor;
+                    }
                 }
-
-                offset += stepSize;
             }
 
             return null;

dist/frost-color.min.js

@@ -1,6 +1,6 @@
 {
     "name": "frostcolor",
-    "version": "2.0.5",
+    "version": "2.0.6",
     "description": "FrostColor is a free, open-source color manipulation library for JavaScript.",
     "keywords": [
         "color",

package.json

@@ -33,31 +33,28 @@ Object.assign(Color, {
     /**
      * Find an optimally contrasting color for another color.
      * @param {Color} color1 The first Color.
-     * @param {Color} color2 The second Color.
+     * @param {Color} [color2] The second Color.
      * @param {number} [minContrast=4.5] The minimum contrast.
      * @param {number} [stepSize=1] The step size.
      * @returns {Color} The new Color.
      */
-    findContrast(color1, color2, minContrast = 4.5, stepSize = 0.01) {
-        const tempColor = this.fromString(color2.toString());
-
-        if (this.contrast(color1, tempColor) >= minContrast) {
-            return tempColor;
+    findContrast(color1, color2 = null, minContrast = 4.5, stepSize = 0.01) {
+        if (!color2) {
+            color2 = color1.clone();
         }
 
-        let offset = stepSize;
-        while (offset <= 1) {
-            const tempColor1 = tempColor.clone().tint(offset);
-            if (this.contrast(color1, tempColor1) >= minContrast) {
-                return tempColor1;
-            }
+        if (this.contrast(color1, color2) >= minContrast) {
+            return color2;
+        }
 
-            const tempColor2 = tempColor.clone().shade(offset);
-            if (this.contrast(color1, tempColor2) >= minContrast) {
-                return tempColor2;
+        const methods = ['tint', 'shade'];
+        for (let i = stepSize; i <= 1; i += stepSize) {
+            for (const method of methods) {
+                const tempColor = color2.clone()[method](i);
+                if (this.contrast(color1, tempColor) >= minContrast) {
+                    return tempColor;
+                }
             }
-
-            offset += stepSize;
         }
 
         return null;

src/Color/static/utility.js

@@ -1,5 +1,5 @@
 /**
- * FrostColor v2.0.5
+ * FrostColor v2.0.6
  * https://github.com/elusivecodes/FrostColor
  */
 (function(global, factory) {

src/wrapper.js

@@ -48,6 +48,18 @@ describe('Color Static', function() {
     });
 
     describe('#findContrast', function() {
+        it('returns a minimally contrasting color', function() {
+            const color1 = new Color(203, 213, 255);
+            const color2 = Color.findContrast(color1);
+            assert.strictEqual(
+                color2.toString(),
+                '#575c6e'
+            );
+            assert.ok(
+                color2 instanceof Color
+            );
+        });
+
         it('returns a minimally contrasting color between two colors', function() {
             const color1 = new Color(203, 213, 255);
             const color2 = new Color(122, 143, 255);
@@ -96,7 +108,7 @@ describe('Color Static', function() {
                 '#4c599e'
             );
             assert.ok(
-                color3 instanceof Color
+                color3 instanceof ColorImmutable
             );
         });
     });

test.html

@@ -48,6 +48,18 @@ describe('ColorImmutable Static', function() {
     });
 
     describe('#findContrast', function() {
+        it('returns a minimally contrasting color', function() {
+            const color1 = new ColorImmutable(203, 213, 255);
+            const color2 = ColorImmutable.findContrast(color1);
+            assert.strictEqual(
+                color2.toString(),
+                '#575c6e'
+            );
+            assert.ok(
+                color2 instanceof ColorImmutable
+            );
+        });
+
         it('returns a minimally contrasting color between two colors', function() {
             const color1 = new ColorImmutable(203, 213, 255);
             const color2 = new ColorImmutable(122, 143, 255);
@@ -96,7 +108,7 @@ describe('ColorImmutable Static', function() {
                 '#4c599e'
             );
             assert.ok(
-                color3 instanceof ColorImmutable
+                color3 instanceof Color
             );
         });
     });