tool-shack 0.0.6 → 0.0.10

package/src/dom/createElement.ts

@@ -7,7 +7,10 @@ import { IExtendingElementProps } from './interfaces/createElement';
  * @param props List of attributes, event listeners or/and children to assign to the newly created element
  * @returns Resulting Node element
  */
-export const createElement = <T = HTMLElement> (tagName: string, props?: Partial<Omit<T, 'children'>> & IExtendingElementProps): T => {
+export const createElement = <T = HTMLElement>(
+  tagName: string,
+  props?: Partial<Omit<T, 'children' | 'dataset'>> & IExtendingElementProps,
+): T => {
   const element: HTMLElement = document.createElement(tagName);
 
   if (props) {
@@ -25,10 +28,18 @@ export const createElement = <T = HTMLElement> (tagName: string, props?: Partial
       } else if (key === 'listeners') {
         for (let eventName in props.listeners!) {
           const functionList = (
-            props.listeners![eventName] instanceof Array ? props.listeners![eventName] : [props.listeners![eventName]]
+            props.listeners![eventName] instanceof Array
+              ? props.listeners![eventName]
+              : [props.listeners![eventName]]
           ) as EventListenerOrEventListenerObject[];
 
-          functionList.forEach((fn: EventListenerOrEventListenerObject) => element.addEventListener(eventName, fn));
+          functionList.forEach((fn: EventListenerOrEventListenerObject) =>
+            element.addEventListener(eventName, fn),
+          );
+        }
+      } else if (key === 'dataset') {
+        for (let datasetKey in props.dataset) {
+          element.dataset[datasetKey] = props.dataset[datasetKey];
         }
       } else {
         (element as any)[key] = value;

package/src/dom/index.ts

@@ -1,6 +1,7 @@
 export * from './interfaces';
 
 export * from './addAsyncEventListener';
+export * from './addClickOutsideListener';
 export * from './addEventListener';
 export * from './appendAfter';
 export * from './appendBefore';

package/src/dom/interfaces/createElement.ts

@@ -1,10 +1,35 @@
-export type TAriaLabelKey = 'atomic' | 'busy' | 'controls' | 'current' | 'describedby' | 'details' | 'disables' |
-  'dropeffect' | 'errormessage' | 'expanded' | 'flowto' | 'grabbed' | 'haspopup' | 'hidden' | 'invalid' |
-  'keyshortcuts' | 'label' | 'labelledby' | 'live' | 'modal' | 'owns' | 'relevant' | 'roledescription';
-
-export interface IExtendingElementProps {
-  children?: HTMLElement[];
-  listeners?: Record<string, EventListenerOrEventListenerObject | EventListenerOrEventListenerObject[]>;
-  role?: string;
-  aria?: Partial<Record<TAriaLabelKey, string>>;
-}
+export type TAriaLabelKey =
+  | 'atomic'
+  | 'busy'
+  | 'controls'
+  | 'current'
+  | 'describedby'
+  | 'details'
+  | 'disables'
+  | 'dropeffect'
+  | 'errormessage'
+  | 'expanded'
+  | 'flowto'
+  | 'grabbed'
+  | 'haspopup'
+  | 'hidden'
+  | 'invalid'
+  | 'keyshortcuts'
+  | 'label'
+  | 'labelledby'
+  | 'live'
+  | 'modal'
+  | 'owns'
+  | 'relevant'
+  | 'roledescription';
+
+export interface IExtendingElementProps {
+  children?: HTMLElement[];
+  listeners?: Record<
+    string,
+    EventListenerOrEventListenerObject | EventListenerOrEventListenerObject[]
+  >;
+  role?: string;
+  aria?: Partial<Record<TAriaLabelKey, string>>;
+  dataset?: Record<string, string>;
+}

package/src/general/index.ts

@@ -0,0 +1,3 @@
+export * from './isEmpty';
+export * from './isNil';
+export * from './isValidJson';

package/src/general/isEmpty.ts

@@ -0,0 +1,21 @@
+import { isNil } from './isNil';
+
+/**
+ * Check if given value is empty
+ *
+ * @param value Value to be checked
+ * @returns Boolean indicating if given value is empty
+ */
+export const isEmpty = (value: any): boolean => {
+  if (value instanceof Function) {
+    return false;
+  }
+
+  return (
+    isNil(value) ||
+    (value instanceof Object &&
+      !Object.keys(value).length &&
+      Object.getPrototypeOf(value) === Object.prototype) ||
+    !value.valueOf().toString().length
+  );
+};

package/src/general/isNil.ts

@@ -0,0 +1,7 @@
+/**
+ * Check if value is equal to null or undefined
+ *
+ * @param value Value to be checked
+ * @returns Boolean indicating if value is equal to null or undefined
+ */
+export const isNil = (value: any): boolean => value === undefined || value === null;

package/src/general/isValidJson.ts

@@ -0,0 +1,15 @@
+/**
+ * Check if string is valid JSON
+ *
+ * @param value String value to be checked
+ * @returns Boolean indicating if string value is a valid JSON
+ */
+export const isValidJson = (value: string): boolean => {
+  try {
+    JSON.parse(value);
+  } catch (error: any) {
+    return false;
+  }
+
+  return true;
+};

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from './browser';
 export * from './dateTime';
 export * from './dom';
-export * from './schedule'
-export * from './string'
+export * from './general';
+export * from './schedule';
+export * from './string';

package/src/schedule/index.ts

@@ -1 +1,2 @@
+export * from './runAnimation';
 export * from './runAsync';

package/src/schedule/runAnimation.ts

@@ -0,0 +1,51 @@
+/**
+ * Run function as animation using requestAnimationFrame
+ *
+ * @param fn Function to be run as animation
+ * @param autoStart If animation should start right away or just return callbacks
+ * @returns Callbacks to start animation (startAnimation) and stop animation (stopAnimation)
+ */
+export const runAnimation = (
+  fn: () => any,
+  autoStart = true,
+): { startAnimation: () => void; stopAnimation: () => void } => {
+  let isRunning = false;
+  let requestedAnimationFrame: number | null = null;
+
+  const runAnimation = (): void => {
+    requestedAnimationFrame = requestAnimationFrame((): void => {
+      fn.call(this);
+
+      if (isRunning) {
+        runAnimation();
+      }
+    });
+  };
+
+  const startAnimation = (): void => {
+    if (isRunning) {
+      return;
+    }
+
+    isRunning = true;
+    runAnimation();
+  };
+
+  const stopAnimation = (): void => {
+    if (!isRunning) {
+      return;
+    }
+
+    isRunning = false;
+
+    if (!!requestedAnimationFrame) {
+      cancelAnimationFrame(requestedAnimationFrame);
+    }
+  };
+
+  if (autoStart) {
+    startAnimation();
+  }
+
+  return { startAnimation, stopAnimation };
+};

package/src/string/index.ts

@@ -1 +1,4 @@
 export * from './escapeHTML';
+export * from './removeDiacritics';
+export * from './slugify';
+export * from './truncate';

package/src/string/removeDiacritics.ts

@@ -0,0 +1,11 @@
+/**
+ * Remove diacritics & accents from string
+ *
+ * @param value String from which should be removed diacritics & accents
+ * @returns ASCII string with removed diacritics & accents
+ */
+export const removeDiacritics = (value: string): string =>
+  value
+    .normalize('NFD')
+    .toString()
+    .replace(/[\u0300-\u036f]/g, '');

package/src/string/slugify.ts

@@ -0,0 +1,17 @@
+import { removeDiacritics } from './removeDiacritics';
+
+/**
+ * Create slug from given string
+ *
+ * @param value String to be slugified
+ * @param separator One character to be used as separator (if provided longer than one character, will be automatically shortened), dash ('-') by default
+ * @returns Slugified string
+ */
+export const slugify = (value: string, separator: string = '-'): string => {
+  separator = separator.trim().substring(0, 1) || '-';
+  const removeCharsRegex = new RegExp(`[^\\\w\\\s${separator}]`, 'g');
+
+  return removeDiacritics(value.trim().toLowerCase())
+    .replace(removeCharsRegex, '')
+    .replace(/\s+/g, separator);
+};

package/src/string/truncate.ts

@@ -0,0 +1,21 @@
+/**
+ * Truncate string to maximum given length if needed and append string at the end (by default "...")
+ *
+ * @param value String value to be truncated
+ * @param maxLength Maximum allowed length
+ * @param appendedString String to append at the end, be default "..."
+ * @returns Truncated value if needed otherwise original value
+ */
+export const truncate = (
+  value: string,
+  maxLength: number,
+  appendedString: string = '...',
+): string => {
+  if (maxLength < appendedString.length) {
+    return appendedString.slice(0, maxLength);
+  }
+
+  return value.length > maxLength
+    ? value.slice(0, maxLength - appendedString.length) + appendedString
+    : value;
+};

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn pretty-quick --staged

package/.husky/pre-push

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-# yarn generate-docs

package/.prettierignore

@@ -1,6 +0,0 @@
-package.json
-package-lock.json
-dist/*
-docs/*
-*.html
-*.test

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "printWidth": 100,
-  "singleQuote": true,
-  "useTabs": false,
-  "tabWidth": 2,
-  "semi": true,
-  "bracketSpacing": true,
-  "trailingComma": "all"
-}