@sme.up/ketchup 9.1.0 → 9.3.0

package/dist/types/managers/kup-dynamic-position/kup-dynamic-position-declarations.d.ts

@@ -18,33 +18,33 @@ export type KupDynamicPositionAnchor = HTMLElement | KupDynamicPositionCoordinat
  * Fixed position element.
  */
 export interface KupDynamicPositionElement extends HTMLElement {
-  kupDynamicPosition?: {
-    anchor: KupDynamicPositionAnchor;
-    detach: boolean;
-    margin: number;
-    originalPath: HTMLElement[];
-    placement: KupDynamicPositionPlacement;
-    rAF: number;
-  };
+    kupDynamicPosition?: {
+        anchor: KupDynamicPositionAnchor;
+        detach: boolean;
+        margin: number;
+        originalPath: HTMLElement[];
+        placement: KupDynamicPositionPlacement;
+        rAF: number;
+    };
 }
 /**
  * Coordinates for fixed positioning.
  */
 export interface KupDynamicPositionCoordinates {
-  x: number;
-  y: number;
+    x: number;
+    y: number;
 }
 /**
  * Available placements.
  */
 export declare enum KupDynamicPositionPlacement {
-  AUTO = "",
-  BOTTOM = "b",
-  BOTTOM_LEFT = "bl",
-  BOTTOM_RIGHT = "br",
-  LEFT = "l",
-  RIGHT = "r",
-  TOP = "t",
-  TOP_LEFT = "tl",
-  TOP_RIGHT = "tr"
+    AUTO = "",
+    BOTTOM = "b",
+    BOTTOM_LEFT = "bl",
+    BOTTOM_RIGHT = "br",
+    LEFT = "l",
+    RIGHT = "r",
+    TOP = "t",
+    TOP_LEFT = "tl",
+    TOP_RIGHT = "tr"
 }

package/dist/types/managers/kup-dynamic-position/kup-dynamic-position.d.ts

@@ -5,57 +5,57 @@ import { KupDynamicPositionPlacement } from './kup-dynamic-position-declarations
  * @module KupDynamicPosition
  */
 export declare class KupDynamicPosition {
-  container: HTMLElement;
-  managedElements: Set<KupDynamicPositionElement>;
-  /**
-   * Initializes KupDynamicPosition.
-   */
-  constructor();
-  /**
-   * Function used to check whether the anchor point is an HTMLElement or a set of coordinates.
-   * @param {KupDynamicPositionAnchor} anchor - Anchor point.
-   * @returns {anchor is HTMLElement} Returns true when the anchor point is an HTMLElement.
-   */
-  anchorIsHTMLElement(anchor: KupDynamicPositionAnchor): anchor is HTMLElement;
-  /**
-   * Watches the element eligible to dynamic positioning.
-   * @param {KupDynamicPositionElement} el - Element to reposition.
-   * @param {KupDynamicPositionAnchor} anchorEl - "el" position will be anchored to this element or to these coordinates.
-   * @param {number} margin - "el" distance from its parent in pixels.
-   * @param {KupDynamicPositionPlacement} placement - "el" placement.
-   * @param {boolean} detach - When true, the function won't be recursive but it will be executed only once. "el" will be detached from its original parent and it will be appended to this.container.
-   */
-  register(el: KupDynamicPositionElement, anchorEl: KupDynamicPositionAnchor, margin?: number, placement?: KupDynamicPositionPlacement, detach?: boolean): void;
-  /**
-   * Changes the anchor point of the given element.
-   * @param {KupDynamicPositionElement} elements - Dynamically positioned element previously registered.
-   * @param {KupDynamicPositionAnchor} anchorEl - New anchor point.
-   */
-  changeAnchor(el: KupDynamicPositionElement, anchorEl: KupDynamicPositionAnchor): void;
-  /**
-   * Removes the element from dynamic position management.
-   * @param {KupDynamicPositionElement[]} elements - Elements to remove from the managed elements set.
-   */
-  unregister(elements: KupDynamicPositionElement[]): void;
-  /**
-   * Returns whether an element was previously registered or not.
-   * @param {KupDynamicPositionElement} el - Element to test.
-   * @returns {boolean} True if the element was registered.
-   */
-  isRegistered(el: KupDynamicPositionElement): boolean;
-  /**
-   * Starts the process of dynamically reposition the element (which must be firstly initialized through this.setup()).
-   * @param {KupDynamicPositionElement} el - Element to reposition.
-   */
-  start(el: KupDynamicPositionElement): void;
-  /**
-   * Ends the process of dynamically reposition the element.
-   * @param {KupDynamicPositionElement} el - Element to reposition.
-   */
-  stop(el: KupDynamicPositionElement): void;
-  /**
-   * This function calculates where to place the element in order to correctly display it attached to its anchor point.
-   * @param {KupDynamicPositionElement} el - Element to reposition.
-   */
-  run(el: KupDynamicPositionElement): void;
+    container: HTMLElement;
+    managedElements: Set<KupDynamicPositionElement>;
+    /**
+     * Initializes KupDynamicPosition.
+     */
+    constructor();
+    /**
+     * Function used to check whether the anchor point is an HTMLElement or a set of coordinates.
+     * @param {KupDynamicPositionAnchor} anchor - Anchor point.
+     * @returns {anchor is HTMLElement} Returns true when the anchor point is an HTMLElement.
+     */
+    anchorIsHTMLElement(anchor: KupDynamicPositionAnchor): anchor is HTMLElement;
+    /**
+     * Watches the element eligible to dynamic positioning.
+     * @param {KupDynamicPositionElement} el - Element to reposition.
+     * @param {KupDynamicPositionAnchor} anchorEl - "el" position will be anchored to this element or to these coordinates.
+     * @param {number} margin - "el" distance from its parent in pixels.
+     * @param {KupDynamicPositionPlacement} placement - "el" placement.
+     * @param {boolean} detach - When true, the function won't be recursive but it will be executed only once. "el" will be detached from its original parent and it will be appended to this.container.
+     */
+    register(el: KupDynamicPositionElement, anchorEl: KupDynamicPositionAnchor, margin?: number, placement?: KupDynamicPositionPlacement, detach?: boolean): void;
+    /**
+     * Changes the anchor point of the given element.
+     * @param {KupDynamicPositionElement} elements - Dynamically positioned element previously registered.
+     * @param {KupDynamicPositionAnchor} anchorEl - New anchor point.
+     */
+    changeAnchor(el: KupDynamicPositionElement, anchorEl: KupDynamicPositionAnchor): void;
+    /**
+     * Removes the element from dynamic position management.
+     * @param {KupDynamicPositionElement[]} elements - Elements to remove from the managed elements set.
+     */
+    unregister(elements: KupDynamicPositionElement[]): void;
+    /**
+     * Returns whether an element was previously registered or not.
+     * @param {KupDynamicPositionElement} el - Element to test.
+     * @returns {boolean} True if the element was registered.
+     */
+    isRegistered(el: KupDynamicPositionElement): boolean;
+    /**
+     * Starts the process of dynamically reposition the element (which must be firstly initialized through this.setup()).
+     * @param {KupDynamicPositionElement} el - Element to reposition.
+     */
+    start(el: KupDynamicPositionElement): void;
+    /**
+     * Ends the process of dynamically reposition the element.
+     * @param {KupDynamicPositionElement} el - Element to reposition.
+     */
+    stop(el: KupDynamicPositionElement): void;
+    /**
+     * This function calculates where to place the element in order to correctly display it attached to its anchor point.
+     * @param {KupDynamicPositionElement} el - Element to reposition.
+     */
+    run(el: KupDynamicPositionElement): void;
 }

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

@@ -26,103 +26,103 @@ export declare const kupDraggableRowAttr: string;
  * Interface for drag & drop elements.
  */
 export interface KupDraggableElement extends HTMLElement {
-  kupDragDrop: KupDraggablePayload;
+    kupDragDrop: KupDraggablePayload;
 }
 /**
  * Drag and drop data transfer.
  */
 export interface KupDraggablePayload extends KupDropEventSource {
-  ghostImage?: HTMLElement;
+    ghostImage?: HTMLElement;
 }
 /**
  * Available effects fro dragging.
  */
 export declare enum KupDragEffect {
-  BADGE = "badge",
-  CLONE = "clone",
-  MOVE = "move",
-  NONE = "none"
+    BADGE = "badge",
+    CLONE = "clone",
+    MOVE = "move",
+    NONE = "none"
 }
 /**
  * Supported types of pointer events.
  */
 export declare enum KupPointerEventTypes {
-  DOUBLETAP = "doubletap",
-  HOLD = "hold",
-  TAP = "tap"
+    DOUBLETAP = "doubletap",
+    HOLD = "hold",
+    TAP = "tap"
 }
 /**
  * Additional callbacks to be made when the related drag event fires.
  */
 export interface KupDragCallbacks {
-  end?: (e?: InteractEvent) => void;
-  move?: (e?: InteractEvent) => void;
-  start?: (e?: InteractEvent) => void;
+    end?: (e?: InteractEvent) => void;
+    move?: (e?: InteractEvent) => void;
+    start?: (e?: InteractEvent) => void;
 }
 /**
  * Additional callbacks to be made when the related drop event fires.
  */
 export interface KupDropCallbacks {
-  drop?: (e?: DropEvent) => void;
-  enter?: (e?: DropEvent) => void;
-  leave?: (e?: DropEvent) => void;
+    drop?: (e?: DropEvent) => void;
+    enter?: (e?: DropEvent) => void;
+    leave?: (e?: DropEvent) => void;
 }
 /**
  * Additional callbacks to be made when the related resize event fires.
  */
 export interface KupResizeCallbacks {
-  move?: (e?: ResizeEvent) => void;
+    move?: (e?: ResizeEvent) => void;
 }
 /**
  * Defines the additional data of the drag event.
  */
 export type KupDragDataTransferCallback = (e?: InteractEvent) => KupDropEventSource;
 export interface KupDragEventData {
-  callback?: KupDragDataTransferCallback;
+    callback?: KupDragDataTransferCallback;
 }
 /**
  * Defines the additional data of the drop event.
  */
 export type KupDropDataTransferCallback = (e?: DropEvent) => KupDropEventTarget;
 export interface KupDropEventData {
-  callback?: KupDropDataTransferCallback;
-  dispatcher: HTMLElement;
-  type: KupDropEventTypes;
+    callback?: KupDropDataTransferCallback;
+    dispatcher: HTMLElement;
+    type: KupDropEventTypes;
 }
 /**
  * Supported types of drop event.
  */
 export declare enum KupDropEventTypes {
-  BOX = "text/kup-box-drag",
-  DATATABLE = "text/kup-data-table-row-drag",
-  GENERIC = "text/generic",
-  MAGICBOX = "text/kup-magic-box-drag"
+    BOX = "text/kup-box-drag",
+    DATATABLE = "text/kup-data-table-row-drag",
+    GENERIC = "text/generic",
+    MAGICBOX = "text/kup-magic-box-drag"
 }
 /**
  * Drop event payload.
  */
 export interface KupDropEventPayload {
-  dataType: KupDropEventTypes;
-  sourceElement: KupDropEventSource;
-  targetElement: KupDropEventTarget;
+    dataType: KupDropEventTypes;
+    sourceElement: KupDropEventSource;
+    targetElement: KupDropEventTarget;
 }
 /**
  * Source of the drop event payload.
  */
 export interface KupDropEventSource {
-  cell?: KupDataCell;
-  column?: KupDataColumn;
-  id?: string;
-  multiple?: boolean;
-  row?: KupDataRow | KupBoxRow;
-  selectedRows?: KupDataRow[] | KupBoxRow[];
+    cell?: KupDataCell;
+    column?: KupDataColumn;
+    id?: string;
+    multiple?: boolean;
+    row?: KupDataRow | KupBoxRow;
+    selectedRows?: KupDataRow[] | KupBoxRow[];
 }
 /**
  * Target of the drop event payload.
  */
 export interface KupDropEventTarget {
-  id?: string;
-  row?: KupDataRow | KupBoxRow;
-  cell?: KupDataCell;
-  column?: KupDataColumn;
+    id?: string;
+    row?: KupDataRow | KupBoxRow;
+    cell?: KupDataCell;
+    column?: KupDataColumn;
 }

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

@@ -7,99 +7,99 @@ import { KupDragCallbacks, KupDragEffect, KupDragEventData, KupDropCallbacks, Ku
  * @module KupInteract
  */
 export declare class KupInteract {
-  container: HTMLElement;
-  defaultModalCb: (e: MouseEvent) => void;
-  managedElements: Set<HTMLElement>;
-  modalBackdrop: HTMLElement;
-  modalCb: (e: MouseEvent) => unknown;
-  restrictContainer: RectResolvable<[
-    number,
-    number,
-    Interaction<keyof ActionMap>
-  ]>;
-  zIndex: number;
-  /**
-   * Initializes KupInteract.
-   * @param {number} zIndex - The starting z-index assigned to dialogs.
-   * @param {RectResolvable<[number, number, Interaction<keyof ActionMap>]>} restrictContainer - The container setting the restriction's boundary.
-   */
-  constructor(zIndex?: number, restrictContainer?: RectResolvable<[
-    number,
-    number,
-    Interaction<keyof ActionMap>
-  ]>);
-  /**
-   * Sets up a new draggable element.
-   * @param {HTMLElement} el - The draggable element.
-   * @param {Partial<DraggableOptions>} options - Options of the draggable element.
-   * @param {KupDragEventData} eventData - Property used to transfer data for the drop event. The callback is used to return information of the starting item - such as cell, column and row info.
-   * @param {KupDragEffect} effect - Visual effect of the drag action.
-   * @param {KupDragCallbacks} callbacks - Additional callbacks to invoke.
-   * @see https://interactjs.io/docs/action-options/ For more options
-   */
-  draggable(el: HTMLElement, options?: Partial<DraggableOptions>, eventData?: KupDragEventData, effect?: KupDragEffect, callbacks?: KupDragCallbacks): void;
-  /**
-   * Sets up a new dropzone.
-   * @param {HTMLElement} el - The dropzone element.
-   * @param {DropzoneOptions} options - Options of the dropzone.
-   * @param {KupDropEventData} eventData - Argument used to transfer data for the drop event. The callback is used to return information of the receiving item - such as cell, column and row info.
-   * @param {KupDropCallbacks} callbacks - Additional callbacks to invoke.
-   * @see https://interactjs.io/docs/action-options/ For more options
-   */
-  dropzone(el: HTMLElement, options?: DropzoneOptions, eventData?: KupDropEventData, callbacks?: KupDropCallbacks): void;
-  /**
-   * Sets up a new resizable element.
-   * @param {HTMLElement} el - The resizable element.
-   * @param {Partial<ResizableOptions>} options - Options of the resize action.
-   * @param {KupResizeCallbacks} callbacks - Additional callbacks to invoke.
-   * @param {boolean} moveOnResize - When true, the element will be moved when resizing in order to keep its position.
-   * @param {boolean} autoResize - When true, the element will be automatically resized (usually the behavior is specified in a callback).
-   * @see https://interactjs.io/docs/action-options/ For more options
-   */
-  resizable(el: HTMLElement, options?: Partial<ResizableOptions>, callbacks?: KupResizeCallbacks, moveOnResize?: boolean, autoResize?: boolean): void;
-  /**
-   * Adds a new interact.js event listener to the given argument.
-   * @param {HTMLElement} el - The element on which the event listener will be added.
-   * @param {KupPointerEventTypes} event - Name of the event.
-   * @param {KupResizeCallbacks} callback - Callback to invoke when the event fires.
-   */
-  on(el: HTMLElement, event: KupPointerEventTypes, callback: ListenersArg): void;
-  /**
-   * This method checks whether the element is breaking the viewport boundaries.
-   * @param {HTMLElement} el - Element to check.
-   * @param {string} oldTransform - Previously set transform, used to rollback in case element breaks viewport boundaries.
-   * @param {Point} delta - X and Y delta values of the last movement.
-   */
-  isInViewport(el: HTMLElement, oldTransform: string, delta: Point): boolean;
-  /**
-   * This method gives the element dialog-like features, by activating moving on drag and, optionally, the resize.
-   * @param {HTMLElement} el - Dialog element.
-   * @param {HTMLElement} handleEl - Element that must be dragged in order to trigger movement. When not provided, dragging anywhere on "el" will move it.
-   * @param {boolean} unresizable - When true, the dialog can't be resized.
-   * @param {RectResolvable<[number, number, Interaction<keyof ActionMap>]>} restrictContainer - When present, it will set the constraint of "el": it can't be moved outside this container.
-   */
-  dialogify(el: HTMLElement, handleEl?: HTMLElement, unresizable?: boolean, restrictContainer?: RectResolvable<[
-    number,
-    number,
-    Interaction<keyof ActionMap>
-  ]>): void;
-  /**
-   * Hides the modal's backdrop.
-   */
-  hideModalBackdrop(): void;
-  /**
-   * Displays the modal's backdrop.
-   */
-  showModalBackdrop(cb?: (e: MouseEvent) => unknown): void;
-  /**
-   * Removes all event listeners from the elements in the array.
-   * @param {HTMLElement[]} elements - Elements to handle.
-   */
-  unregister(elements: HTMLElement[]): void;
-  /**
-   * Checks whether an element is currently registered or not.
-   * @param {HTMLElement} el - Element to test.
-   * @returns {boolean} True if the element was registered.
-   */
-  isRegistered(el: HTMLElement): boolean;
+    container: HTMLElement;
+    defaultModalCb: (e: MouseEvent) => void;
+    managedElements: Set<HTMLElement>;
+    modalBackdrop: HTMLElement;
+    modalCb: (e: MouseEvent) => unknown;
+    restrictContainer: RectResolvable<[
+        number,
+        number,
+        Interaction<keyof ActionMap>
+    ]>;
+    zIndex: number;
+    /**
+     * Initializes KupInteract.
+     * @param {number} zIndex - The starting z-index assigned to dialogs.
+     * @param {RectResolvable<[number, number, Interaction<keyof ActionMap>]>} restrictContainer - The container setting the restriction's boundary.
+     */
+    constructor(zIndex?: number, restrictContainer?: RectResolvable<[
+        number,
+        number,
+        Interaction<keyof ActionMap>
+    ]>);
+    /**
+     * Sets up a new draggable element.
+     * @param {HTMLElement} el - The draggable element.
+     * @param {Partial<DraggableOptions>} options - Options of the draggable element.
+     * @param {KupDragEventData} eventData - Property used to transfer data for the drop event. The callback is used to return information of the starting item - such as cell, column and row info.
+     * @param {KupDragEffect} effect - Visual effect of the drag action.
+     * @param {KupDragCallbacks} callbacks - Additional callbacks to invoke.
+     * @see https://interactjs.io/docs/action-options/ For more options
+     */
+    draggable(el: HTMLElement, options?: Partial<DraggableOptions>, eventData?: KupDragEventData, effect?: KupDragEffect, callbacks?: KupDragCallbacks): void;
+    /**
+     * Sets up a new dropzone.
+     * @param {HTMLElement} el - The dropzone element.
+     * @param {DropzoneOptions} options - Options of the dropzone.
+     * @param {KupDropEventData} eventData - Argument used to transfer data for the drop event. The callback is used to return information of the receiving item - such as cell, column and row info.
+     * @param {KupDropCallbacks} callbacks - Additional callbacks to invoke.
+     * @see https://interactjs.io/docs/action-options/ For more options
+     */
+    dropzone(el: HTMLElement, options?: DropzoneOptions, eventData?: KupDropEventData, callbacks?: KupDropCallbacks): void;
+    /**
+     * Sets up a new resizable element.
+     * @param {HTMLElement} el - The resizable element.
+     * @param {Partial<ResizableOptions>} options - Options of the resize action.
+     * @param {KupResizeCallbacks} callbacks - Additional callbacks to invoke.
+     * @param {boolean} moveOnResize - When true, the element will be moved when resizing in order to keep its position.
+     * @param {boolean} autoResize - When true, the element will be automatically resized (usually the behavior is specified in a callback).
+     * @see https://interactjs.io/docs/action-options/ For more options
+     */
+    resizable(el: HTMLElement, options?: Partial<ResizableOptions>, callbacks?: KupResizeCallbacks, moveOnResize?: boolean, autoResize?: boolean): void;
+    /**
+     * Adds a new interact.js event listener to the given argument.
+     * @param {HTMLElement} el - The element on which the event listener will be added.
+     * @param {KupPointerEventTypes} event - Name of the event.
+     * @param {KupResizeCallbacks} callback - Callback to invoke when the event fires.
+     */
+    on(el: HTMLElement, event: KupPointerEventTypes, callback: ListenersArg): void;
+    /**
+     * This method checks whether the element is breaking the viewport boundaries.
+     * @param {HTMLElement} el - Element to check.
+     * @param {string} oldTransform - Previously set transform, used to rollback in case element breaks viewport boundaries.
+     * @param {Point} delta - X and Y delta values of the last movement.
+     */
+    isInViewport(el: HTMLElement, oldTransform: string, delta: Point): boolean;
+    /**
+     * This method gives the element dialog-like features, by activating moving on drag and, optionally, the resize.
+     * @param {HTMLElement} el - Dialog element.
+     * @param {HTMLElement} handleEl - Element that must be dragged in order to trigger movement. When not provided, dragging anywhere on "el" will move it.
+     * @param {boolean} unresizable - When true, the dialog can't be resized.
+     * @param {RectResolvable<[number, number, Interaction<keyof ActionMap>]>} restrictContainer - When present, it will set the constraint of "el": it can't be moved outside this container.
+     */
+    dialogify(el: HTMLElement, handleEl?: HTMLElement, unresizable?: boolean, restrictContainer?: RectResolvable<[
+        number,
+        number,
+        Interaction<keyof ActionMap>
+    ]>): void;
+    /**
+     * Hides the modal's backdrop.
+     */
+    hideModalBackdrop(): void;
+    /**
+     * Displays the modal's backdrop.
+     */
+    showModalBackdrop(cb?: (e: MouseEvent) => unknown): void;
+    /**
+     * Removes all event listeners from the elements in the array.
+     * @param {HTMLElement[]} elements - Elements to handle.
+     */
+    unregister(elements: HTMLElement[]): void;
+    /**
+     * Checks whether an element is currently registered or not.
+     * @param {HTMLElement} el - Element to test.
+     * @returns {boolean} True if the element was registered.
+     */
+    isRegistered(el: HTMLElement): boolean;
 }