docs(easing): adding a list of valid function names to easing functio…

…n docs
styled-components · Feb 1, 2024 · b579442 · b579442
1 parent cee9894
commit b579442
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 11 deletions.
diff --git a/docs/assets/polished.js b/docs/assets/polished.js
@@ -858,7 +858,8 @@
   };
 
   /**
-   * String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).
+   * String to represent common easing functions as demonstrated here: https://easings.net/.
+   * Valid function names are: back, circ, cubic, expo, quad, quart, quint, sine.
    *
    * @example
    * // Styles as object usage
@@ -893,7 +894,8 @@
   };
 
   /**
-   * String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).
+   * String to represent common easing functions as demonstrated here: https://easings.net/.
+   * Valid function names are: back, circ, cubic, expo, quad, quart, quint, sine.
    *
    * @example
    * // Styles as object usage
@@ -928,7 +930,8 @@
   };
 
   /**
-   * String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).
+   * String to represent common easing functions as demonstrated here: https://easings.net/.
+   * Valid function names are: back, circ, cubic, expo, quad, quart, quint, sine.
    *
    * @example
    * // Styles as object usage

diff --git a/docs/docs/index.html b/docs/docs/index.html
@@ -2795,7 +2795,7 @@ <h3 class='fl m0' id='timingfunctions'>
   </div>
 
 
-  <p>String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).</p>
+  <p>String to represent common easing functions as demonstrated here: (<a href="https://easings.net/">https://easings.net/</a>).</p>
 
 
   <div class='pre p1 fill-light mt0'>timingFunctions(timingFunction: <a href="#timingfunction">TimingFunction</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></div>
@@ -9468,7 +9468,8 @@ <h3 class='fl m0' id='easein'>
   </div>
 
 
-  <p>String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).</p>
+  <p>String to represent common easing functions as demonstrated here: (<a href="https://easings.net/">https://easings.net/</a>).</p>
+<p>Valid function names are: back, circ, cubic, expo, quad, quart, quint, sine.</p>
 
 
   <div class='pre p1 fill-light mt0'>easeIn(functionName: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>): <a href="#timingfunction">TimingFunction</a></div>
@@ -9573,7 +9574,8 @@ <h3 class='fl m0' id='easeinout'>
   </div>
 
 
-  <p>String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).</p>
+  <p>String to represent common easing functions as demonstrated here: (<a href="https://easings.net/">https://easings.net/</a>).</p>
+<p>Valid function names are: back, circ, cubic, expo, quad, quart, quint, sine.</p>
 
 
   <div class='pre p1 fill-light mt0'>easeInOut(functionName: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>): <a href="#timingfunction">TimingFunction</a></div>
@@ -9678,7 +9680,8 @@ <h3 class='fl m0' id='easeout'>
   </div>
 
 
-  <p>String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).</p>
+  <p>String to represent common easing functions as demonstrated here: (<a href="https://easings.net/">https://easings.net/</a>).</p>
+<p>Valid function names are: back, circ, cubic, expo, quad, quart, quint, sine.</p>
 
 
   <div class='pre p1 fill-light mt0'>easeOut(functionName: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>): <a href="#timingfunction">TimingFunction</a></div>

diff --git a/src/easings/easeIn.js b/src/easings/easeIn.js
@@ -13,7 +13,9 @@ const functionsMap = {
 }
 
 /**
- * String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).
+ * String to represent common easing functions as demonstrated here: (https://easings.net/).
+ *
+ * Valid function names are: back, circ, cubic, expo, quad, quart, quint, sine.
  *
  * @example
  * // Styles as object usage

diff --git a/src/easings/easeInOut.js b/src/easings/easeInOut.js
@@ -13,7 +13,9 @@ const functionsMap = {
 }
 
 /**
- * String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).
+ * String to represent common easing functions as demonstrated here: (https://easings.net/).
+ *
+ * Valid function names are: back, circ, cubic, expo, quad, quart, quint, sine.
  *
  * @example
  * // Styles as object usage

diff --git a/src/easings/easeOut.js b/src/easings/easeOut.js
@@ -13,7 +13,9 @@ const functionsMap = {
 }
 
 /**
- * String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).
+ * String to represent common easing functions as demonstrated here: (https://easings.net/).
+ *
+ * Valid function names are: back, circ, cubic, expo, quad, quart, quint, sine.
  *
  * @example
  * // Styles as object usage

diff --git a/src/mixins/timingFunctions.js b/src/mixins/timingFunctions.js
@@ -37,7 +37,7 @@ function getTimingFunction(functionName: string): string {
 }
 
 /**
- * String to represent common easing functions as demonstrated here: (github.com/jaukia/easie).
+ * String to represent common easing functions as demonstrated here: (https://easings.net/).
  *
  * @deprecated - This will be deprecated in v5 in favor of `easeIn`, `easeOut`, `easeInOut`.
  *