@kws3/ui 1.9.1 → 2.0.0

package/utils/index.js

@@ -1,32 +1,64 @@
-export function truncate(str, len) {
+/**
+ * Truncate a string.
+ * @param {string} [str=""] - String to truncate, Default: `""`
+ * @param {number} [len=0] - The number of characters to extract, Default: `""`
+ */
+export function truncate(str = "", len = 0) {
   return str && str.length >= len + 3 ? str.substr(0, len) + "..." : str;
 }
 
-export function nl2br(input) {
+/**
+ * Insert line breaks where newlines (\n) occur in the string.
+ * @param {string} [input=""] - String to be checked, Default: `""`
+ */
+export function nl2br(input = "") {
   if (!input) {
     return "";
   }
-  return (input + "").replace(/\n/g, "<br>");
+  let html = (input + ``).replace(/\n/g, "<br/>");
+  return html;
 }
 
+/**
+ * Clone an Object.
+ * @param {object} [obj={}] - Object to be cloned, Default: `{}`
+ */
 export function cloneObject(obj) {
   return JSON.parse(JSON.stringify(obj));
 }
 
+/**
+ * Request an animation before the next repaint.
+ * @param {function} [callback=function(){}] - callback function
+ */
 export var rAF =
   window.requestAnimationFrame ||
+  //@ts-ignore
   window.webkitRequestAnimationFrame ||
+  //@ts-ignore
   window.mozRequestAnimationFrame ||
+  //@ts-ignore
   window.oRequestAnimationFrame ||
+  //@ts-ignore
   window.msRequestAnimationFrame ||
   function (callback) {
     window.setTimeout(callback, 1000 / 60);
   };
 
-export function debounce(fn, threshold, isAsap) {
+/**
+ * Returns a function, that, as long as it continues to be invoked, will not
+ * be triggered. The function will be called after it stops being called for
+ * `threshold` milliseconds.
+ * @param {function} [fn=function(){}] - The function that you want to execute after the debounce time
+ * @param {number} [threshold=100] - The amount of time to wait, Default: `100`
+ * @param {boolean} [isAsap=false] - flag to debounce early, Default: `false`
+ *
+ */
+export function debounce(fn = function () {}, threshold, isAsap) {
   var timeout, result;
   function debounced() {
     var args = arguments,
+      //@ts-ignore
       context = this;
     function delayed() {
       if (!isAsap) {
@@ -48,14 +80,83 @@ export function debounce(fn, threshold, isAsap) {
   return debounced;
 }
 
-export function capitaliseFirstLetter(string) {
+/**
+ * Capitalise First letter of string.
+ * @param {string} [string=""] - A string whose first letter is to be capitalised, Default: `""`
+ */
+export function capitaliseFirstLetter(string = "") {
   return string.charAt(0).toUpperCase() + string.toLowerCase().slice(1);
 }
 
-export function isEnterKey(e) {
-  return e.keyCode && e.keyCode === 13;
+/**
+ * Returns Date Object.
+ * Makes mysql dates work in safari
+ * @param {string} [strDate=""] - Date String., Default: `""`
+ */
+export function createDate(strDate) {
+  // eslint-disable-next-line @kws3/svelte3/no-date-string-arg
+  return strDate ? new Date(strDate.replace(/-/g, "/")) : null;
 }
 
-export function isEscKey(e) {
-  return e.keyCode && e.keyCode === 27;
+/**
+ * Returns currency format.
+ * @param {number} [n=''] - Number., Default: `""`
+ */
+export function currency(n) {
+  var nn = Number(n);
+  return (isNaN(nn) ? 0 : nn).toFixed(2);
+}
+
+/**
+ * Converts date to ordinal.
+ * @param {number} [n=''] - Number., Default: `""`
+ */
+export function dateToOrdinal(n) {
+  n = Number(n);
+  return (
+    n +
+    (n > 0
+      ? ["th", "st", "nd", "rd"][(n > 3 && n < 21) || n % 10 > 3 ? 0 : n % 10]
+      : "")
+  );
+}
+
+/**
+ * Returns a random integer between min (inclusive) and max (inclusive).
+ * The value is no lower than min (or the next integer greater than min
+ * if min isn't an integer) and no greater than max (or the next integer
+ * lower than max if max isn't an integer).
+ * @param {number} [min] - Minimum Number.
+ * @param {number} [max] - Maximum Number.
+ */
+export function randomIntegerFromInterval(min = 0, max = Infinity) {
+  min = Math.ceil(min);
+  max = Math.floor(max);
+  return Math.floor(Math.random() * (max - min + 1)) + min;
+}
+
+/**
+ * Returns random percentage.
+ * @param {number} [min=1] - Minimum Number, Default: `1`
+ * @param {number} [max=100] - Maximum Number, Default: `100`
+ */
+export function randomPercent(min = 1, max = 100) {
+  return randomIntegerFromInterval(min, max) + "%";
+}
+
+/**
+ * Downloads file.
+ * @param {Object} [data={}] - File data.
+ * @param {string} [fileName=''] - File Name.
+ */
+export function fileDownloader(data, fileName = "file_name") {
+  let a = document.createElement("a");
+  document.body.appendChild(a);
+  a.setAttribute("style", "display: none");
+  let blob = new Blob([data], { type: "octet/stream" }),
+    url = window.URL.createObjectURL(blob);
+  a.href = url;
+  a.download = fileName;
+  a.click();
+  window.URL.revokeObjectURL(url);
 }

package/utils/fuzzysearch.js

@@ -1,20 +0,0 @@
-export default function fuzzysearch(needle, haystack) {
-  var tlen = haystack.length;
-  var qlen = needle.length;
-  if (qlen > tlen) {
-    return false;
-  }
-  if (qlen === tlen) {
-    return needle === haystack;
-  }
-  outer: for (var i = 0, j = 0; i < qlen; i++) {
-    var nch = needle.charCodeAt(i);
-    while (j < tlen) {
-      if (haystack.charCodeAt(j++) === nch) {
-        continue outer;
-      }
-    }
-    return false;
-  }
-  return true;
-}

package/utils/keyboard-events.js

@@ -1,32 +0,0 @@
-let events = [
-  {name: 'enter', code: 13},
-  {name: 'tab', code: 9},
-  {name: 'escape', code: 27},
-  {name: 'space', code: 32},
-  {name: 'leftarrow', code: 37},
-  {name: 'rightarrow', code: 39},
-  {name: 'downarrow', code: 40},
-  {name: 'uparrow', code: 38},
-  {name: 'backspace', code: 8},
-  {name: 'del', code: 46},
-];
-
-export function keyboardEvents(node) {
-  function keydownHandler(event) {
-    events.forEach(({name, code}) => {
-      let which = event.which || event.keyCode;
-      if (which === code) {
-        node.dispatchEvent(
-          new CustomEvent(name)
-        );
-      }
-    });
-  }
-  node.addEventListener('keydown', keydownHandler, false);
-
-  return {
-    destroy() {
-      node.removeEventListener('keydown', keydownHandler, false);
-    }
-  };
-}