@sme.up/ketchup 9.1.0 → 9.3.0

package/dist/types/managers/kup-objects/kup-objects.d.ts

@@ -6,205 +6,205 @@ import type { KupObj, KupObjectsJSON } from './kup-objects-declarations';
  * @module KupObjects
  */
 export declare class KupObjects {
-  list: KupObjectsJSON;
-  /**
-   * Initializes KupObjects.
-   * @param {KupObjectsJSON} list - Overrides the default obj.json.
-   */
-  constructor(list?: KupObjectsJSON);
-  /**
-   * Checks whether the object can automatically derive columns.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when columns can be automatically derived from the object.
-   */
-  canHaveAutomaticDerivedColumn(obj: KupObj): boolean;
-  /**
-   * Checks whether the objects can have extra columns or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object has extra columns.
-   */
-  canObjsHaveExtraColumns(objs: KupObj[]): boolean;
-  /**
-   * Checks whether the object can have extra columns or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object has extra columns.
-   */
-  canObjHaveExtraColumns(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a bar or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a bar.
-   */
-  isBar(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a button or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a button.
-   */
-  isButton(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a chart or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a chart.
-   */
-  isChart(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a checkbox or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a checkbox.
-   */
-  isCheckbox(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a color or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a color.
-   */
-  isColor(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a date or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a date.
-   */
-  isDate(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents an icon or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is an icon.
-   */
-  isIcon(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents an image or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is an image.
-   */
-  isImage(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents an object list or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is an object list.
-   */
-  isKupObjList(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a link or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a link.
-   */
-  isLink(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a number or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a number.
-   */
-  isNumber(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a positive number or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a positive number.
-   */
-  isPositiveNumber(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a password or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a password.
-   */
-  isPassword(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a percentage or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a percentage.
-   */
-  isPercentage(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a progress bar or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a progress bar.
-   */
-  isProgressBar(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a radio button or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a radio button.
-   */
-  isRadio(obj: KupObj): boolean;
-  /**
-   * Checks whether the object can be identifiable as a string.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object can be considered as a string.
-   */
-  isStringObject(obj: any): boolean;
-  /**
-   * Checks whether the object represents a switch or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a switch.
-   */
-  isSwitch(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a text field or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a text field.
-   */
-  isTextField(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a time or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a time.
-   */
-  isTime(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a timestamp or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a timestamp.
-   */
-  isTimestamp(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a time and handles seconds or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a time and handles seconds.
-   */
-  isTimeWithSeconds(obj: KupObj): boolean;
-  /**
-   * Checks whether the object represents a verb or not.
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is a verb.
-   */
-  isVoCodver(obj: KupObj): boolean;
-  /**
-   * Checks whether the object is null or empty
-   * @param {KupObj} obj - Object to check.
-   * @returns {boolean} True when the object is null or empty.
-   */
-  isEmptyKupObj(obj: KupObj): boolean;
-  /**
-   * Checks whether the arguments have the same object or not.
-   * @param {KupObj[]} objs - Array of KupObj.
-   * @returns {boolean} True when it's the same object.
-   */
-  isSameKupObj(objs: KupObj[]): boolean;
-  /**
-   * Parses a date depending on the object's type.
-   * @param {KupObj} obj - Object to check.
-   * @returns {Dayjs} Dayjs object.
-   */
-  parseDate(obj: KupObj): Dayjs;
-  /**
-   * Check whether two JS objects are deeply equal. When the arguments aren't objects, they are tested directly for equity.
-   * @param {GenericObject} object1 - First object to test.
-   * @param {GenericObject} object2 - Second object to test.
-   * @returns {boolean} True if the objects are equal.
-   * @see https://dmitripavlutin.com/how-to-compare-objects-in-javascript/#4-deep-equality
-   */
-  deepEqual(object1: any, object2: any): boolean;
-  /**
-   * Check whether the argument is a JavaScript object.
-   * @param {GenericObject} object - Object to test.
-   * @returns {boolean} True if the argument is a JavaScript object.
-   * @see https://dmitripavlutin.com/how-to-compare-objects-in-javascript/#4-deep-equality
-   */
-  isJsObject(object: any): boolean;
-  /**
-   * Check whether the object is empty or not.
-   * @param {GenericObject} object - Object to check.
-   * @returns {boolean} True if the object is empty.
-   */
-  isEmptyJsObject(obj: GenericObject): boolean;
+    list: KupObjectsJSON;
+    /**
+     * Initializes KupObjects.
+     * @param {KupObjectsJSON} list - Overrides the default obj.json.
+     */
+    constructor(list?: KupObjectsJSON);
+    /**
+     * Checks whether the object can automatically derive columns.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when columns can be automatically derived from the object.
+     */
+    canHaveAutomaticDerivedColumn(obj: KupObj): boolean;
+    /**
+     * Checks whether the objects can have extra columns or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object has extra columns.
+     */
+    canObjsHaveExtraColumns(objs: KupObj[]): boolean;
+    /**
+     * Checks whether the object can have extra columns or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object has extra columns.
+     */
+    canObjHaveExtraColumns(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a bar or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a bar.
+     */
+    isBar(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a button or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a button.
+     */
+    isButton(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a chart or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a chart.
+     */
+    isChart(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a checkbox or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a checkbox.
+     */
+    isCheckbox(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a color or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a color.
+     */
+    isColor(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a date or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a date.
+     */
+    isDate(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents an icon or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is an icon.
+     */
+    isIcon(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents an image or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is an image.
+     */
+    isImage(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents an object list or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is an object list.
+     */
+    isKupObjList(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a link or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a link.
+     */
+    isLink(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a number or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a number.
+     */
+    isNumber(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a positive number or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a positive number.
+     */
+    isPositiveNumber(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a password or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a password.
+     */
+    isPassword(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a percentage or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a percentage.
+     */
+    isPercentage(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a progress bar or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a progress bar.
+     */
+    isProgressBar(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a radio button or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a radio button.
+     */
+    isRadio(obj: KupObj): boolean;
+    /**
+     * Checks whether the object can be identifiable as a string.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object can be considered as a string.
+     */
+    isStringObject(obj: any): boolean;
+    /**
+     * Checks whether the object represents a switch or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a switch.
+     */
+    isSwitch(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a text field or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a text field.
+     */
+    isTextField(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a time or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a time.
+     */
+    isTime(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a timestamp or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a timestamp.
+     */
+    isTimestamp(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a time and handles seconds or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a time and handles seconds.
+     */
+    isTimeWithSeconds(obj: KupObj): boolean;
+    /**
+     * Checks whether the object represents a verb or not.
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is a verb.
+     */
+    isVoCodver(obj: KupObj): boolean;
+    /**
+     * Checks whether the object is null or empty
+     * @param {KupObj} obj - Object to check.
+     * @returns {boolean} True when the object is null or empty.
+     */
+    isEmptyKupObj(obj: KupObj): boolean;
+    /**
+     * Checks whether the arguments have the same object or not.
+     * @param {KupObj[]} objs - Array of KupObj.
+     * @returns {boolean} True when it's the same object.
+     */
+    isSameKupObj(objs: KupObj[]): boolean;
+    /**
+     * Parses a date depending on the object's type.
+     * @param {KupObj} obj - Object to check.
+     * @returns {Dayjs} Dayjs object.
+     */
+    parseDate(obj: KupObj): Dayjs;
+    /**
+     * Check whether two JS objects are deeply equal. When the arguments aren't objects, they are tested directly for equity.
+     * @param {GenericObject} object1 - First object to test.
+     * @param {GenericObject} object2 - Second object to test.
+     * @returns {boolean} True if the objects are equal.
+     * @see https://dmitripavlutin.com/how-to-compare-objects-in-javascript/#4-deep-equality
+     */
+    deepEqual(object1: any, object2: any): boolean;
+    /**
+     * Check whether the argument is a JavaScript object.
+     * @param {GenericObject} object - Object to test.
+     * @returns {boolean} True if the argument is a JavaScript object.
+     * @see https://dmitripavlutin.com/how-to-compare-objects-in-javascript/#4-deep-equality
+     */
+    isJsObject(object: any): boolean;
+    /**
+     * Check whether the object is empty or not.
+     * @param {GenericObject} object - Object to check.
+     * @returns {boolean} True if the object is empty.
+     */
+    isEmptyJsObject(obj: GenericObject): boolean;
 }

package/dist/types/managers/kup-scroll-on-hover/kup-scroll-on-hover-declarations.d.ts

@@ -2,27 +2,27 @@
  * Element scrollable on mouse over.
  */
 export interface KupScrollOnHoverElement extends HTMLElement {
-  scrollOnHover: {
-    active: boolean;
-    children: NodeListOf<HTMLElement>;
-    percentages: KupScrollOnHoverPercentages;
-    rect: DOMRect;
-    step?: number;
-    vertical: boolean;
-    x: number;
-    y: number;
-  };
+    scrollOnHover: {
+        active: boolean;
+        children: NodeListOf<HTMLElement>;
+        percentages: KupScrollOnHoverPercentages;
+        rect: DOMRect;
+        step?: number;
+        vertical: boolean;
+        x: number;
+        y: number;
+    };
 }
 export interface KupScrollOnHoverPercentages {
-  back: number;
-  forward: number;
+    back: number;
+    forward: number;
 }
 /**
  * The direction to which ScollableElement can be scrolled.
  */
 export declare enum ScrollOnHoverDirection {
-  BOTTOM = "bottom",
-  LEFT = "left",
-  RIGHT = "right",
-  TOP = "top"
+    BOTTOM = "bottom",
+    LEFT = "left",
+    RIGHT = "right",
+    TOP = "top"
 }

package/dist/types/managers/kup-scroll-on-hover/kup-scroll-on-hover.d.ts

@@ -4,59 +4,59 @@ import { KupScrollOnHoverElement, KupScrollOnHoverPercentages, ScrollOnHoverDire
  * @module KupScrollOnHover
  */
 export declare class KupScrollOnHover {
-  #private;
-  container: HTMLElement;
-  delay: number;
-  managedElements: Set<KupScrollOnHoverElement>;
-  step: number;
-  /**
-   * Initializes KupScrollOnHover.
-   * @param {number} delay - Sets the time in milliseconds before the scrolling starts when mouse-hovering.
-   * @param {number} step - The amount in pixels for each scroll recursion.
-   */
-  constructor(delay?: number, step?: number);
-  /**
-   * Watches the given element in order to trigger the scroll on hover when conditions are met.
-   * Children nodes with the "hover-scrolling-child" will be watched and scrolled when el scrolls.
-   * @param {KupScrollOnHoverElement} el - Element to watch.
-   * @param {boolean} vertical - Enables vertical scroll.
-   * @param {KupScrollOnHoverPercentages} percentages - Sets how big is the area in which the scroll is enabled.
-   * @param {number} step - The amount in pixels for each scroll recursion.
-   */
-  register(el: KupScrollOnHoverElement, vertical?: boolean, percentages?: KupScrollOnHoverPercentages, step?: number): void;
-  /**
-   * Removes the given element from ScrollOnHover watchlist.
-   * @param {KupScrollOnHoverElement} el - Element to unregister.
-   */
-  unregister(el: KupScrollOnHoverElement): void;
-  /**
-   * Returns whether an element was previously registered or not.
-   * @param {KupScrollOnHoverElement} el - Element to test.
-   * @returns {boolean} True if the element was registered.
-   */
-  isRegistered(el: KupScrollOnHoverElement): boolean;
-  /**
-   * When called, this function prepares the class for the scrolling process.
-   * @param {MouseEvent} event - The starter event, which should be a MouseMove event.
-   */
-  start(event: MouseEvent): Promise<void>;
-  /**
-   * When called, this function stops the scrolling process.
-   * @param {KupScrollOnHoverElement} el - The scrolled element.
-   */
-  stop(el: KupScrollOnHoverElement): Promise<void>;
-  /**
-   * The actual recursive scroll function.
-   * @param {KupScrollOnHoverElement} el - The scrolled element.
-   * @param {number} maxScrollLeft - Left coordinates to which the recursiveness must be stopped.
-   * @param {number} percForward - Range of the right (or bottom) area.
-   * @param {number} percBack - Range of the left (or top) scrollable area.
-   * @param {ScrollOnHoverDirection} direction - Direction of the scroll.
-   */
-  run(el: KupScrollOnHoverElement, maxScrollLeft: number, percForward: number, percBack: number, direction: ScrollOnHoverDirection): void;
-  /**
-   * Scrolls children of the element having the "hover-scrolling-child" class
-   * @param {KupScrollOnHoverElement} el - The scrolled element.
-   */
-  updateChildren(el: KupScrollOnHoverElement): void;
+    #private;
+    container: HTMLElement;
+    delay: number;
+    managedElements: Set<KupScrollOnHoverElement>;
+    step: number;
+    /**
+     * Initializes KupScrollOnHover.
+     * @param {number} delay - Sets the time in milliseconds before the scrolling starts when mouse-hovering.
+     * @param {number} step - The amount in pixels for each scroll recursion.
+     */
+    constructor(delay?: number, step?: number);
+    /**
+     * Watches the given element in order to trigger the scroll on hover when conditions are met.
+     * Children nodes with the "hover-scrolling-child" will be watched and scrolled when el scrolls.
+     * @param {KupScrollOnHoverElement} el - Element to watch.
+     * @param {boolean} vertical - Enables vertical scroll.
+     * @param {KupScrollOnHoverPercentages} percentages - Sets how big is the area in which the scroll is enabled.
+     * @param {number} step - The amount in pixels for each scroll recursion.
+     */
+    register(el: KupScrollOnHoverElement, vertical?: boolean, percentages?: KupScrollOnHoverPercentages, step?: number): void;
+    /**
+     * Removes the given element from ScrollOnHover watchlist.
+     * @param {KupScrollOnHoverElement} el - Element to unregister.
+     */
+    unregister(el: KupScrollOnHoverElement): void;
+    /**
+     * Returns whether an element was previously registered or not.
+     * @param {KupScrollOnHoverElement} el - Element to test.
+     * @returns {boolean} True if the element was registered.
+     */
+    isRegistered(el: KupScrollOnHoverElement): boolean;
+    /**
+     * When called, this function prepares the class for the scrolling process.
+     * @param {MouseEvent} event - The starter event, which should be a MouseMove event.
+     */
+    start(event: MouseEvent): Promise<void>;
+    /**
+     * When called, this function stops the scrolling process.
+     * @param {KupScrollOnHoverElement} el - The scrolled element.
+     */
+    stop(el: KupScrollOnHoverElement): Promise<void>;
+    /**
+     * The actual recursive scroll function.
+     * @param {KupScrollOnHoverElement} el - The scrolled element.
+     * @param {number} maxScrollLeft - Left coordinates to which the recursiveness must be stopped.
+     * @param {number} percForward - Range of the right (or bottom) area.
+     * @param {number} percBack - Range of the left (or top) scrollable area.
+     * @param {ScrollOnHoverDirection} direction - Direction of the scroll.
+     */
+    run(el: KupScrollOnHoverElement, maxScrollLeft: number, percForward: number, percBack: number, direction: ScrollOnHoverDirection): void;
+    /**
+     * Scrolls children of the element having the "hover-scrolling-child" class
+     * @param {KupScrollOnHoverElement} el - The scrolled element.
+     */
+    updateChildren(el: KupScrollOnHoverElement): void;
 }

package/dist/types/managers/kup-search/kup-search-declarations.d.ts

@@ -3,5 +3,5 @@ export declare const searchStartEvent = "kup-search-start";
  * Payload of the event fired when a search is launched without props.
  */
 export interface KupSearchEventPayload {
-  card: HTMLKupCardElement;
+    card: HTMLKupCardElement;
 }

package/dist/types/managers/kup-search/kup-search.d.ts

@@ -4,17 +4,17 @@ import { KupCard } from '../../components/kup-card/kup-card';
  * @module KupSearch
  */
 export declare class KupSearch {
-  activeCards: Set<HTMLKupCardElement>;
-  container: HTMLElement;
-  /**
-   * Initializes KupSearch.
-   */
-  constructor();
-  /**
-   * Starts the search process.
-   * @param {Function} callback - The callback that must be invoked when the search is over.
-   * @param {Partial<KupCard>} props - The props of the search card. When missing, the search will display a spinner in place of the data table.
-   * @returns {HTMLKupCardElement} The search card created by this method.
-   */
-  start(callback: Function, props?: Partial<KupCard>): HTMLKupCardElement;
+    activeCards: Set<HTMLKupCardElement>;
+    container: HTMLElement;
+    /**
+     * Initializes KupSearch.
+     */
+    constructor();
+    /**
+     * Starts the search process.
+     * @param {Function} callback - The callback that must be invoked when the search is over.
+     * @param {Partial<KupCard>} props - The props of the search card. When missing, the search will display a spinner in place of the data table.
+     * @returns {HTMLKupCardElement} The search card created by this method.
+     */
+    start(callback: Function, props?: Partial<KupCard>): HTMLKupCardElement;
 }