@sme.up/ketchup 8.0.2 → 8.2.0

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

@@ -1,128 +1,128 @@
-import type { DropEvent, InteractEvent } from '@interactjs/types/index';
-import type { ResizeEvent } from '@interactjs/actions/resize/plugin';
-import { KupBoxRow } from '../../components/kup-box/kup-box-declarations';
-import { KupDataCell, KupDataColumn, KupDataRow } from '../kup-data/kup-data-declarations';
-/**
- * HTML Attribute attached to dialogs.
- * Referenced by kup-theme.css
- */
-export declare const kupDialogAttribute = "kup-dialog";
-/**
- * CSS class attached to resizable dialogs.
- * Referenced by kup-theme.css
- */
-export declare const kupDialogResizableClass = "kup-resizable";
-/**
- * Drag & drop variables.
- */
-export declare const kupDropEvent: string;
-export declare const kupDragActiveAttr: string;
-export declare const kupDragOverAttr: string;
-export declare const kupDraggableAttr: string;
-export declare const kupDraggableCellAttr: string;
-export declare const kupDraggableColumnAttr: string;
-export declare const kupDraggableRowAttr: string;
-/**
- * Interface for drag & drop elements.
- */
-export interface KupDraggableElement extends HTMLElement {
-  kupDragDrop: KupDraggablePayload;
-}
-/**
- * Drag and drop data transfer.
- */
-export interface KupDraggablePayload extends KupDropEventSource {
-  ghostImage?: HTMLElement;
-}
-/**
- * Available effects fro dragging.
- */
-export declare enum KupDragEffect {
-  BADGE = "badge",
-  CLONE = "clone",
-  MOVE = "move",
-  NONE = "none"
-}
-/**
- * Supported types of pointer events.
- */
-export declare enum KupPointerEventTypes {
-  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;
-}
-/**
- * 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;
-}
-/**
- * Additional callbacks to be made when the related resize event fires.
- */
-export interface KupResizeCallbacks {
-  move?: (e?: ResizeEvent) => void;
-}
-/**
- * Defines the additional data of the drag event.
- */
-export type KupDragDataTransferCallback = (e?: InteractEvent) => KupDropEventSource;
-export interface KupDragEventData {
-  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;
-}
-/**
- * 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"
-}
-/**
- * Drop event payload.
- */
-export interface KupDropEventPayload {
-  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[];
-}
-/**
- * Target of the drop event payload.
- */
-export interface KupDropEventTarget {
-  id?: string;
-  row?: KupDataRow | KupBoxRow;
-  cell?: KupDataCell;
-  column?: KupDataColumn;
-}
+import type { DropEvent, InteractEvent } from '@interactjs/types/index';
+import type { ResizeEvent } from '@interactjs/actions/resize/plugin';
+import { KupBoxRow } from '../../components/kup-box/kup-box-declarations';
+import { KupDataCell, KupDataColumn, KupDataRow } from '../kup-data/kup-data-declarations';
+/**
+ * HTML Attribute attached to dialogs.
+ * Referenced by kup-theme.css
+ */
+export declare const kupDialogAttribute = "kup-dialog";
+/**
+ * CSS class attached to resizable dialogs.
+ * Referenced by kup-theme.css
+ */
+export declare const kupDialogResizableClass = "kup-resizable";
+/**
+ * Drag & drop variables.
+ */
+export declare const kupDropEvent: string;
+export declare const kupDragActiveAttr: string;
+export declare const kupDragOverAttr: string;
+export declare const kupDraggableAttr: string;
+export declare const kupDraggableCellAttr: string;
+export declare const kupDraggableColumnAttr: string;
+export declare const kupDraggableRowAttr: string;
+/**
+ * Interface for drag & drop elements.
+ */
+export interface KupDraggableElement extends HTMLElement {
+  kupDragDrop: KupDraggablePayload;
+}
+/**
+ * Drag and drop data transfer.
+ */
+export interface KupDraggablePayload extends KupDropEventSource {
+  ghostImage?: HTMLElement;
+}
+/**
+ * Available effects fro dragging.
+ */
+export declare enum KupDragEffect {
+  BADGE = "badge",
+  CLONE = "clone",
+  MOVE = "move",
+  NONE = "none"
+}
+/**
+ * Supported types of pointer events.
+ */
+export declare enum KupPointerEventTypes {
+  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;
+}
+/**
+ * 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;
+}
+/**
+ * Additional callbacks to be made when the related resize event fires.
+ */
+export interface KupResizeCallbacks {
+  move?: (e?: ResizeEvent) => void;
+}
+/**
+ * Defines the additional data of the drag event.
+ */
+export type KupDragDataTransferCallback = (e?: InteractEvent) => KupDropEventSource;
+export interface KupDragEventData {
+  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;
+}
+/**
+ * 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"
+}
+/**
+ * Drop event payload.
+ */
+export interface KupDropEventPayload {
+  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[];
+}
+/**
+ * Target of the drop event payload.
+ */
+export interface KupDropEventTarget {
+  id?: string;
+  row?: KupDataRow | KupBoxRow;
+  cell?: KupDataCell;
+  column?: KupDataColumn;
+}

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

@@ -1,105 +1,105 @@
-import type { Interaction } from '@interactjs/core/Interaction';
-import type { ActionMap } from '@interactjs/core/scope';
-import type { DraggableOptions, DropzoneOptions, ListenersArg, Point, RectResolvable, ResizableOptions } from '@interactjs/types/index';
-import { KupDragCallbacks, KupDragEffect, KupDragEventData, KupDropCallbacks, KupDropEventData, KupPointerEventTypes, KupResizeCallbacks } from './kup-interact-declarations';
-/**
- * This class handles elements as dialogs, making them resizable and movable.
- * @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;
-}
+import type { Interaction } from '@interactjs/core/Interaction';
+import type { ActionMap } from '@interactjs/core/scope';
+import type { DraggableOptions, DropzoneOptions, ListenersArg, Point, RectResolvable, ResizableOptions } from '@interactjs/types/index';
+import { KupDragCallbacks, KupDragEffect, KupDragEventData, KupDropCallbacks, KupDropEventData, KupPointerEventTypes, KupResizeCallbacks } from './kup-interact-declarations';
+/**
+ * This class handles elements as dialogs, making them resizable and movable.
+ * @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;
+}