gridstack 4.2.7 → 4.4.1

package/dist/es5/types.d.ts

@@ -0,0 +1,258 @@
+/**
+ * types.ts 4.4.1
+ * Copyright (c) 2021 Alain Dumesny - see GridStack root license
+ */
+import { GridStack } from './gridstack';
+/** different layout options when changing # of columns,
+ * including a custom function that takes new/old column count, and array of new/old positions
+ * Note: new list may be partially already filled if we have a cache of the layout at that size and new items were added later.
+ */
+export declare type ColumnOptions = 'moveScale' | 'move' | 'scale' | 'none' | ((column: number, oldColumn: number, nodes: GridStackNode[], oldNodes: GridStackNode[]) => void);
+export declare type numberOrString = number | string;
+export interface GridItemHTMLElement extends HTMLElement {
+    /** pointer to grid node instance */
+    gridstackNode?: GridStackNode;
+}
+export declare type GridStackElement = string | HTMLElement | GridItemHTMLElement;
+export declare type GridStackEventHandlerCallback = (event: Event, arg2?: GridItemHTMLElement | GridStackNode | GridStackNode[], newNode?: GridStackNode) => void;
+/**
+ * Defines the options for a Grid
+ */
+export interface GridStackOptions {
+    /**
+     * accept widgets dragged from other grids or from outside (default: `false`). Can be:
+     * `true` (uses `'.grid-stack-item'` class filter) or `false`,
+     * string for explicit class name,
+     * function returning a boolean. See [example](http://gridstack.github.io/gridstack.js/demo/two.html)
+     */
+    acceptWidgets?: boolean | string | ((element: Element) => boolean);
+    /** possible values (default: `false` only show on hover)
+      * `true` the resizing handles are always shown even if the user is not hovering over the widget
+      * advance condition such as this mobile browser agent check:
+      `alwaysShowResizeHandle: /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( navigator.userAgent )`
+      See [example](http://gridstack.github.io/gridstack.js/demo/mobile.html) */
+    alwaysShowResizeHandle?: boolean;
+    /** turns animation on (default?: true) */
+    animate?: boolean;
+    /** if false gridstack will not initialize existing items (default?: true) */
+    auto?: boolean;
+    /**
+     * one cell height (default?: 'auto'). Can be:
+     *  an integer (px)
+     *  a string (ex: '100px', '10em', '10rem'). Note: % doesn't right - see demo/cell-height.html
+     *  0, in which case the library will not generate styles for rows. Everything must be defined in your own CSS files.
+     *  'auto' - height will be calculated for square cells (width / column) and updated live as you resize the window - also see `cellHeightThrottle`
+     *  'initial' - similar to 'auto' (start at square cells) but stay that size during window resizing.
+     */
+    cellHeight?: numberOrString;
+    /** throttle time delay (in ms) used when cellHeight='auto' to improve performance vs usability (default?: 100).
+     * A value of 0 will make it instant at a cost of re-creating the CSS file at ever window resize event!
+     * */
+    cellHeightThrottle?: number;
+    /** (internal) unit for cellHeight (default? 'px') which is set when a string cellHeight with a unit is passed (ex: '10rem') */
+    cellHeightUnit?: string;
+    /** list of children item to create when calling load() or addGrid() */
+    children?: GridStackWidget[];
+    /** number of columns (default?: 12). Note: IF you change this, CSS also have to change. See https://github.com/gridstack/gridstack.js#change-grid-columns */
+    column?: number;
+    /** additional class on top of '.grid-stack' (which is required for our CSS) to differentiate this instance.
+    Note: only used by addGrid(), else your element should have the needed class */
+    class?: string;
+    /** disallows dragging of widgets (default?: false) */
+    disableDrag?: boolean;
+    /** disables the onColumnMode when the grid width is less than minWidth (default?: false) */
+    disableOneColumnMode?: boolean;
+    /** disallows resizing of widgets (default?: false). */
+    disableResize?: boolean;
+    /** allows to override UI draggable options. (default?: { handle?: '.grid-stack-item-content', scroll?: true, appendTo?: 'body', containment: null }) */
+    draggable?: DDDragOpt;
+    /** allows to drag external items using this selector - see dragInOptions. (default: undefined) */
+    dragIn?: string;
+    /** allows to drag external items using these options. See `GridStack.setupDragIn()` instead (not per grid really).
+     * (default?: { handle: '.grid-stack-item-content', revert: 'invalid', scroll: false, appendTo: 'body' })
+     * helper can be 'clone' or your own function (set what the drag/dropped item will be instead)
+     */
+    dragInOptions?: DDDragInOpt;
+    /** let user drag nested grid items out of a parent or not (default false) */
+    dragOut?: boolean;
+    /** enable floating widgets (default?: false) See example (http://gridstack.github.io/gridstack.js/demo/float.html) */
+    float?: boolean;
+    /** draggable handle selector (default?: '.grid-stack-item-content') */
+    handle?: string;
+    /** draggable handle class (e.g. 'grid-stack-item-content'). If set 'handle' is ignored (default?: null) */
+    handleClass?: string;
+    /** additional widget class (default?: 'grid-stack-item') */
+    itemClass?: string;
+    /**
+     * gap between grid item and content (default?: 10). This will set all 4 sides and support the CSS formats below
+     *  an integer (px)
+     *  a string with possible units (ex: '2em', '20px', '2rem')
+     *  string with space separated values (ex: '5px 10px 0 20px' for all 4 sides, or '5em 10em' for top/bottom and left/right pairs like CSS).
+     * Note: all sides must have same units (last one wins, default px)
+     */
+    margin?: numberOrString;
+    /** OLD way to optionally set each side - use margin: '5px 10px 0 20px' instead. Used internally to store each side. */
+    marginTop?: numberOrString;
+    marginRight?: numberOrString;
+    marginBottom?: numberOrString;
+    marginLeft?: numberOrString;
+    /** (internal) unit for margin (default? 'px') set when `margin` is set as string with unit (ex: 2rem') */
+    marginUnit?: string;
+    /** maximum rows amount. Default? is 0 which means no maximum rows */
+    maxRow?: number;
+    /** minimum rows amount. Default is `0`. You can also do this with `min-height` CSS attribute
+     * on the grid div in pixels, which will round to the closest row.
+     */
+    minRow?: number;
+    /** minimal width. If grid width is less, grid will be shown in one column mode (default?: 768) */
+    minWidth?: number;
+    /**
+     * set to true if you want oneColumnMode to use the DOM order and ignore x,y from normal multi column
+     * layouts during sorting. This enables you to have custom 1 column layout that differ from the rest. (default?: false)
+     */
+    oneColumnModeDomSort?: boolean;
+    /** class for placeholder (default?: 'grid-stack-placeholder') */
+    placeholderClass?: string;
+    /** placeholder default content (default?: '') */
+    placeholderText?: string;
+    /** allows to override UI resizable options. (default?: { autoHide: true, handles: 'se' }) */
+    resizable?: DDResizeOpt;
+    /**
+     * if true widgets could be removed by dragging outside of the grid. It could also be a selector string (ex: ".trash"),
+     * in this case widgets will be removed by dropping them there (default?: false)
+     * See example (http://gridstack.github.io/gridstack.js/demo/two.html)
+     */
+    removable?: boolean | string;
+    /** allows to override UI removable options. (default?: { accept: '.grid-stack-item' }) */
+    removableOptions?: DDRemoveOpt;
+    /** fix grid number of rows. This is a shortcut of writing `minRow:N, maxRow:N`. (default `0` no constrain) */
+    row?: number;
+    /**
+     * if true turns grid to RTL. Possible values are true, false, 'auto' (default?: 'auto')
+     * See [example](http://gridstack.github.io/gridstack.js/demo/rtl.html)
+     */
+    rtl?: boolean | 'auto';
+    /**
+     * makes grid static (default?: false). If `true` widgets are not movable/resizable.
+     * You don't even need draggable/resizable. A CSS class
+     * 'grid-stack-static' is also added to the element.
+     */
+    staticGrid?: boolean;
+    /** if `true` will add style element to `<head>` otherwise will add it to element's parent node (default `false`). */
+    styleInHead?: boolean;
+}
+/** options used during GridStackEngine.moveNode() */
+export interface GridStackMoveOpts extends GridStackPosition {
+    /** node to skip collision */
+    skip?: GridStackNode;
+    /** do we pack (default true) */
+    pack?: boolean;
+    /** true if we are calling this recursively to prevent simple swap or coverage collision - default false*/
+    nested?: boolean;
+    /** vars to calculate other cells coordinates */
+    cellWidth?: number;
+    cellHeight?: number;
+    marginTop?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    marginRight?: number;
+    /** position in pixels of the currently dragged items (for overlap check) */
+    rect?: GridStackPosition;
+    /** true if we're live resizing */
+    resizing?: boolean;
+}
+export interface GridStackPosition {
+    /** widget position x (default?: 0) */
+    x?: number;
+    /** widget position y (default?: 0) */
+    y?: number;
+    /** widget dimension width (default?: 1) */
+    w?: number;
+    /** widget dimension height (default?: 1) */
+    h?: number;
+}
+/**
+ * GridStack Widget creation options
+ */
+export interface GridStackWidget extends GridStackPosition {
+    /** if true then x, y parameters will be ignored and widget will be places on the first available position (default?: false) */
+    autoPosition?: boolean;
+    /** minimum width allowed during resize/creation (default?: undefined = un-constrained) */
+    minW?: number;
+    /** maximum width allowed during resize/creation (default?: undefined = un-constrained) */
+    maxW?: number;
+    /** minimum height allowed during resize/creation (default?: undefined = un-constrained) */
+    minH?: number;
+    /** maximum height allowed during resize/creation (default?: undefined = un-constrained) */
+    maxH?: number;
+    /** prevent resizing (default?: undefined = un-constrained) */
+    noResize?: boolean;
+    /** prevents moving (default?: undefined = un-constrained) */
+    noMove?: boolean;
+    /** prevents being moved by others during their (default?: undefined = un-constrained) */
+    locked?: boolean;
+    /** widgets can have their own custom resize handles. For example 'e,w' will make that particular widget only resize east and west. See `resizable: {handles: string}` option */
+    resizeHandles?: string;
+    /** value for `gs-id` stored on the widget (default?: undefined) */
+    id?: numberOrString;
+    /** html to append inside as content */
+    content?: string;
+    /** optional nested grid options and list of children, which then turns into actual instance at runtime */
+    subGrid?: GridStackOptions | GridStack;
+}
+/** Drag&Drop resize options */
+export interface DDResizeOpt {
+    /** do resize handle hide by default until mouse over ? - default: true */
+    autoHide?: boolean;
+    /**
+     * sides where you can resize from (ex: 'e, se, s, sw, w') - default 'se' (south-east)
+     * Note: it is not recommended to resize from the top sides as weird side effect may occur.
+    */
+    handles?: string;
+}
+/** Drag&Drop remove options */
+export interface DDRemoveOpt {
+    /** class that can be removed (default?: '.' + opts.itemClass) */
+    accept?: string;
+}
+/** Drag&Drop dragging options */
+export interface DDDragOpt {
+    /** class selector of items that can be dragged. default to '.grid-stack-item-content' */
+    handle?: string;
+    /** default to `true` */
+    scroll?: boolean;
+    /** default to 'body' */
+    appendTo?: string;
+    /** parent constraining where item can be dragged out from (default: null = no constrain) */
+    containment?: string;
+}
+export interface DDDragInOpt extends DDDragOpt {
+    /** used when dragging item from the outside, and canceling (ex: 'invalid' or your own method)*/
+    revert?: string | ((event: Event) => HTMLElement);
+    /** helper function when dropping (ex: 'clone' or your own method) */
+    helper?: string | ((event: Event) => HTMLElement);
+}
+export interface Size {
+    width: number;
+    height: number;
+}
+export interface Position {
+    top: number;
+    left: number;
+}
+export interface Rect extends Size, Position {
+}
+/** data that is passed during drag and resizing callbacks */
+export interface DDUIData {
+    position?: Position;
+    size?: Size;
+}
+/**
+ * internal descriptions describing the items in the grid
+ */
+export interface GridStackNode extends GridStackWidget {
+    /** pointer back to HTML element */
+    el?: GridItemHTMLElement;
+    /** pointer back to Grid instance */
+    grid?: GridStack;
+}

package/dist/es5/types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * types.ts 4.4.1
+ * Copyright (c) 2021 Alain Dumesny - see GridStack root license
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/es5/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\r\n * types.ts 4.4.1\r\n * Copyright (c) 2021 Alain Dumesny - see GridStack root license\r\n */\r\n\r\nimport { GridStack } from './gridstack';\r\n\r\n\r\n/** different layout options when changing # of columns,\r\n * including a custom function that takes new/old column count, and array of new/old positions\r\n * Note: new list may be partially already filled if we have a cache of the layout at that size and new items were added later.\r\n */\r\nexport type ColumnOptions = 'moveScale' | 'move' | 'scale' | 'none' |\r\n  ((column: number, oldColumn: number, nodes: GridStackNode[], oldNodes: GridStackNode[]) => void);\r\n\r\nexport type numberOrString = number | string;\r\nexport interface GridItemHTMLElement extends HTMLElement {\r\n  /** pointer to grid node instance */\r\n  gridstackNode?: GridStackNode;\r\n  /** @internal */\r\n  _gridstackNodeOrig?: GridStackNode;\r\n}\r\n\r\nexport type GridStackElement = string | HTMLElement | GridItemHTMLElement;\r\n\r\nexport type GridStackEventHandlerCallback = (event: Event, arg2?: GridItemHTMLElement | GridStackNode | GridStackNode[], newNode?: GridStackNode) => void;\r\n\r\n/**\r\n * Defines the options for a Grid\r\n */\r\nexport interface GridStackOptions {\r\n  /**\r\n   * accept widgets dragged from other grids or from outside (default: `false`). Can be:\r\n   * `true` (uses `'.grid-stack-item'` class filter) or `false`,\r\n   * string for explicit class name,\r\n   * function returning a boolean. See [example](http://gridstack.github.io/gridstack.js/demo/two.html)\r\n   */\r\n  acceptWidgets?: boolean | string | ((element: Element) => boolean);\r\n\r\n  /** possible values (default: `false` only show on hover)\r\n    * `true` the resizing handles are always shown even if the user is not hovering over the widget\r\n    * advance condition such as this mobile browser agent check:\r\n    `alwaysShowResizeHandle: /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( navigator.userAgent )`\r\n    See [example](http://gridstack.github.io/gridstack.js/demo/mobile.html) */\r\n  alwaysShowResizeHandle?: boolean;\r\n\r\n  /** turns animation on (default?: true) */\r\n  animate?: boolean;\r\n\r\n  /** if false gridstack will not initialize existing items (default?: true) */\r\n  auto?: boolean;\r\n\r\n  /**\r\n   * one cell height (default?: 'auto'). Can be:\r\n   *  an integer (px)\r\n   *  a string (ex: '100px', '10em', '10rem'). Note: % doesn't right - see demo/cell-height.html\r\n   *  0, in which case the library will not generate styles for rows. Everything must be defined in your own CSS files.\r\n   *  'auto' - height will be calculated for square cells (width / column) and updated live as you resize the window - also see `cellHeightThrottle`\r\n   *  'initial' - similar to 'auto' (start at square cells) but stay that size during window resizing.\r\n   */\r\n  cellHeight?: numberOrString;\r\n\r\n  /** throttle time delay (in ms) used when cellHeight='auto' to improve performance vs usability (default?: 100).\r\n   * A value of 0 will make it instant at a cost of re-creating the CSS file at ever window resize event!\r\n   * */\r\n  cellHeightThrottle?: number;\r\n\r\n  /** (internal) unit for cellHeight (default? 'px') which is set when a string cellHeight with a unit is passed (ex: '10rem') */\r\n  cellHeightUnit?: string;\r\n\r\n  /** list of children item to create when calling load() or addGrid() */\r\n  children?: GridStackWidget[];\r\n\r\n  /** number of columns (default?: 12). Note: IF you change this, CSS also have to change. See https://github.com/gridstack/gridstack.js#change-grid-columns */\r\n  column?: number;\r\n\r\n  /** additional class on top of '.grid-stack' (which is required for our CSS) to differentiate this instance.\r\n  Note: only used by addGrid(), else your element should have the needed class */\r\n  class?: string;\r\n\r\n  /** disallows dragging of widgets (default?: false) */\r\n  disableDrag?: boolean;\r\n\r\n  /** disables the onColumnMode when the grid width is less than minWidth (default?: false) */\r\n  disableOneColumnMode?: boolean;\r\n\r\n  /** disallows resizing of widgets (default?: false). */\r\n  disableResize?: boolean;\r\n\r\n  /** allows to override UI draggable options. (default?: { handle?: '.grid-stack-item-content', scroll?: true, appendTo?: 'body', containment: null }) */\r\n  draggable?: DDDragOpt;\r\n\r\n  /** allows to drag external items using this selector - see dragInOptions. (default: undefined) */\r\n  dragIn?: string;\r\n\r\n  /** allows to drag external items using these options. See `GridStack.setupDragIn()` instead (not per grid really).\r\n   * (default?: { handle: '.grid-stack-item-content', revert: 'invalid', scroll: false, appendTo: 'body' })\r\n   * helper can be 'clone' or your own function (set what the drag/dropped item will be instead)\r\n   */\r\n  dragInOptions?: DDDragInOpt;\r\n\r\n  /** let user drag nested grid items out of a parent or not (default false) */\r\n  dragOut?: boolean;\r\n\r\n  /** enable floating widgets (default?: false) See example (http://gridstack.github.io/gridstack.js/demo/float.html) */\r\n  float?: boolean;\r\n\r\n  /** draggable handle selector (default?: '.grid-stack-item-content') */\r\n  handle?: string;\r\n\r\n  /** draggable handle class (e.g. 'grid-stack-item-content'). If set 'handle' is ignored (default?: null) */\r\n  handleClass?: string;\r\n\r\n  /** additional widget class (default?: 'grid-stack-item') */\r\n  itemClass?: string;\r\n\r\n  /**\r\n   * gap between grid item and content (default?: 10). This will set all 4 sides and support the CSS formats below\r\n   *  an integer (px)\r\n   *  a string with possible units (ex: '2em', '20px', '2rem')\r\n   *  string with space separated values (ex: '5px 10px 0 20px' for all 4 sides, or '5em 10em' for top/bottom and left/right pairs like CSS).\r\n   * Note: all sides must have same units (last one wins, default px)\r\n   */\r\n  margin?: numberOrString;\r\n\r\n  /** OLD way to optionally set each side - use margin: '5px 10px 0 20px' instead. Used internally to store each side. */\r\n  marginTop?: numberOrString;\r\n  marginRight?: numberOrString;\r\n  marginBottom?: numberOrString;\r\n  marginLeft?: numberOrString;\r\n\r\n  /** (internal) unit for margin (default? 'px') set when `margin` is set as string with unit (ex: 2rem') */\r\n  marginUnit?: string;\r\n\r\n  /** maximum rows amount. Default? is 0 which means no maximum rows */\r\n  maxRow?: number;\r\n\r\n  /** minimum rows amount. Default is `0`. You can also do this with `min-height` CSS attribute\r\n   * on the grid div in pixels, which will round to the closest row.\r\n   */\r\n  minRow?: number;\r\n\r\n  /** minimal width. If grid width is less, grid will be shown in one column mode (default?: 768) */\r\n  minWidth?: number;\r\n\r\n  /**\r\n   * set to true if you want oneColumnMode to use the DOM order and ignore x,y from normal multi column\r\n   * layouts during sorting. This enables you to have custom 1 column layout that differ from the rest. (default?: false)\r\n   */\r\n  oneColumnModeDomSort?: boolean;\r\n\r\n  /** class for placeholder (default?: 'grid-stack-placeholder') */\r\n  placeholderClass?: string;\r\n\r\n  /** placeholder default content (default?: '') */\r\n  placeholderText?: string;\r\n\r\n  /** allows to override UI resizable options. (default?: { autoHide: true, handles: 'se' }) */\r\n  resizable?: DDResizeOpt;\r\n\r\n  /**\r\n   * if true widgets could be removed by dragging outside of the grid. It could also be a selector string (ex: \".trash\"),\r\n   * in this case widgets will be removed by dropping them there (default?: false)\r\n   * See example (http://gridstack.github.io/gridstack.js/demo/two.html)\r\n   */\r\n  removable?: boolean | string;\r\n\r\n  /** allows to override UI removable options. (default?: { accept: '.grid-stack-item' }) */\r\n  removableOptions?: DDRemoveOpt;\r\n\r\n  /** fix grid number of rows. This is a shortcut of writing `minRow:N, maxRow:N`. (default `0` no constrain) */\r\n  row?: number;\r\n\r\n  /**\r\n   * if true turns grid to RTL. Possible values are true, false, 'auto' (default?: 'auto')\r\n   * See [example](http://gridstack.github.io/gridstack.js/demo/rtl.html)\r\n   */\r\n  rtl?: boolean | 'auto';\r\n\r\n  /**\r\n   * makes grid static (default?: false). If `true` widgets are not movable/resizable.\r\n   * You don't even need draggable/resizable. A CSS class\r\n   * 'grid-stack-static' is also added to the element.\r\n   */\r\n  staticGrid?: boolean;\r\n\r\n  /** if `true` will add style element to `<head>` otherwise will add it to element's parent node (default `false`). */\r\n  styleInHead?: boolean;\r\n\r\n  /** @internal point to a parent grid item if we're nested */\r\n  _isNested?: GridStackNode;\r\n  /** @internal unique class name for our generated CSS style sheet */\r\n  _styleSheetClass?: string;\r\n}\r\n\r\n/** options used during GridStackEngine.moveNode() */\r\nexport interface GridStackMoveOpts extends GridStackPosition {\r\n  /** node to skip collision */\r\n  skip?: GridStackNode;\r\n  /** do we pack (default true) */\r\n  pack?: boolean;\r\n  /** true if we are calling this recursively to prevent simple swap or coverage collision - default false*/\r\n  nested?: boolean;\r\n  /** vars to calculate other cells coordinates */\r\n  cellWidth?: number;\r\n  cellHeight?: number;\r\n  marginTop?: number;\r\n  marginBottom?: number;\r\n  marginLeft?: number;\r\n  marginRight?: number;\r\n  /** position in pixels of the currently dragged items (for overlap check) */\r\n  rect?: GridStackPosition;\r\n  /** true if we're live resizing */\r\n  resizing?: boolean;\r\n}\r\n\r\nexport interface GridStackPosition {\r\n  /** widget position x (default?: 0) */\r\n  x?: number;\r\n  /** widget position y (default?: 0) */\r\n  y?: number;\r\n  /** widget dimension width (default?: 1) */\r\n  w?: number;\r\n  /** widget dimension height (default?: 1) */\r\n  h?: number;\r\n}\r\n\r\n/**\r\n * GridStack Widget creation options\r\n */\r\nexport interface GridStackWidget extends GridStackPosition {\r\n  /** if true then x, y parameters will be ignored and widget will be places on the first available position (default?: false) */\r\n  autoPosition?: boolean;\r\n  /** minimum width allowed during resize/creation (default?: undefined = un-constrained) */\r\n  minW?: number;\r\n  /** maximum width allowed during resize/creation (default?: undefined = un-constrained) */\r\n  maxW?: number;\r\n  /** minimum height allowed during resize/creation (default?: undefined = un-constrained) */\r\n  minH?: number;\r\n  /** maximum height allowed during resize/creation (default?: undefined = un-constrained) */\r\n  maxH?: number;\r\n  /** prevent resizing (default?: undefined = un-constrained) */\r\n  noResize?: boolean;\r\n  /** prevents moving (default?: undefined = un-constrained) */\r\n  noMove?: boolean;\r\n  /** prevents being moved by others during their (default?: undefined = un-constrained) */\r\n  locked?: boolean;\r\n  /** widgets can have their own custom resize handles. For example 'e,w' will make that particular widget only resize east and west. See `resizable: {handles: string}` option */\r\n  resizeHandles?: string;\r\n  /** value for `gs-id` stored on the widget (default?: undefined) */\r\n  id?: numberOrString;\r\n  /** html to append inside as content */\r\n  content?: string;\r\n  /** optional nested grid options and list of children, which then turns into actual instance at runtime */\r\n  subGrid?: GridStackOptions | GridStack;\r\n}\r\n\r\n/** Drag&Drop resize options */\r\nexport interface DDResizeOpt {\r\n  /** do resize handle hide by default until mouse over ? - default: true */\r\n  autoHide?: boolean;\r\n  /**\r\n   * sides where you can resize from (ex: 'e, se, s, sw, w') - default 'se' (south-east)\r\n   * Note: it is not recommended to resize from the top sides as weird side effect may occur.\r\n  */\r\n  handles?: string;\r\n}\r\n\r\n/** Drag&Drop remove options */\r\nexport interface DDRemoveOpt {\r\n  /** class that can be removed (default?: '.' + opts.itemClass) */\r\n  accept?: string;\r\n}\r\n\r\n/** Drag&Drop dragging options */\r\nexport interface DDDragOpt {\r\n  /** class selector of items that can be dragged. default to '.grid-stack-item-content' */\r\n  handle?: string;\r\n  /** default to `true` */\r\n  scroll?: boolean;\r\n  /** default to 'body' */\r\n  appendTo?: string;\r\n  /** parent constraining where item can be dragged out from (default: null = no constrain) */\r\n  containment?: string;\r\n}\r\nexport interface DDDragInOpt extends DDDragOpt {\r\n    /** used when dragging item from the outside, and canceling (ex: 'invalid' or your own method)*/\r\n    revert?: string | ((event: Event) => HTMLElement);\r\n    /** helper function when dropping (ex: 'clone' or your own method) */\r\n    helper?: string | ((event: Event) => HTMLElement);\r\n}\r\n\r\nexport interface Size {\r\n  width: number;\r\n  height: number;\r\n}\r\nexport interface Position {\r\n  top: number;\r\n  left: number;\r\n}\r\nexport interface Rect extends Size, Position {}\r\n\r\n/** data that is passed during drag and resizing callbacks */\r\nexport interface DDUIData {\r\n  position?: Position;\r\n  size?: Size;\r\n  /* fields not used by GridStack but sent by jq ? leave in case we go back to them...\r\n  originalPosition? : Position;\r\n  offset?: Position;\r\n  originalSize?: Size;\r\n  element?: HTMLElement[];\r\n  helper?: HTMLElement[];\r\n  originalElement?: HTMLElement[];\r\n  */\r\n}\r\n\r\n/**\r\n * internal descriptions describing the items in the grid\r\n */\r\nexport interface GridStackNode extends GridStackWidget {\r\n  /** pointer back to HTML element */\r\n  el?: GridItemHTMLElement;\r\n  /** pointer back to Grid instance */\r\n  grid?: GridStack;\r\n  /** @internal internal id used to match when cloning engines or saving column layouts */\r\n  _id?: number;\r\n  /** @internal */\r\n  _dirty?: boolean;\r\n  /** @internal */\r\n  _updating?: boolean;\r\n  /** @internal true when over trash/another grid so we don't bother removing drag CSS style that would animate back to old position */\r\n  _isAboutToRemove?: boolean;\r\n  /** @internal true if item came from outside of the grid -> actual item need to be moved over */\r\n  _isExternal?: boolean;\r\n  /** @internal moving vs resizing */\r\n  _moving?: boolean;\r\n  /** @internal true if we jumped down past item below (one time jump so we don't have to totally pass it) */\r\n  _skipDown?: boolean;\r\n  /** @internal original values before a drag/size */\r\n  _orig?: GridStackPosition;\r\n  /** @internal position in pixels used during collision check  */\r\n  _rect?: GridStackPosition;\r\n  /** @internal top/left pixel location before a drag so we can detect direction of move from last position*/\r\n  _lastUiPosition?: Position;\r\n  /** @internal set on the item being dragged/resized remember the last positions we've tried (but failed) so we don't try again during drag/resize */\r\n  _lastTried?: GridStackPosition;\r\n  /** @internal position willItFit() will use to position the item */\r\n  _willFitPos?: GridStackPosition;\r\n  /** @internal last drag Y pixel position used to incrementally update V scroll bar */\r\n  _prevYPix?: number;\r\n  /** @internal true if we've remove the item from ourself (dragging out) but might revert it back (release on nothing -> goes back) */\r\n  _temporaryRemoved?: boolean;\r\n  /** @internal true if we should remove DOM element on _notify() rather than clearing _id (old way) */\r\n  _removeDOM?: boolean;\r\n  /** @internal */\r\n  _initDD?: boolean;\r\n}\r\n"]}

package/dist/es5/utils.d.ts

@@ -0,0 +1,73 @@
+/**
+ * utils.ts 4.4.1
+ * Copyright (c) 2021 Alain Dumesny - see GridStack root license
+ */
+import { GridStackElement, GridStackNode, GridStackOptions, numberOrString, GridStackPosition, GridStackWidget } from './types';
+export interface HeightData {
+    h: number;
+    unit: string;
+}
+/** checks for obsolete method names */
+export declare function obsolete(self: any, f: any, oldName: string, newName: string, rev: string): (...args: any[]) => any;
+/** checks for obsolete grid options (can be used for any fields, but msg is about options) */
+export declare function obsoleteOpts(opts: GridStackOptions, oldName: string, newName: string, rev: string): void;
+/** checks for obsolete grid options which are gone */
+export declare function obsoleteOptsDel(opts: GridStackOptions, oldName: string, rev: string, info: string): void;
+/** checks for obsolete Jquery element attributes */
+export declare function obsoleteAttr(el: HTMLElement, oldName: string, newName: string, rev: string): void;
+/**
+ * Utility methods
+ */
+export declare class Utils {
+    /** convert a potential selector into actual list of html elements */
+    static getElements(els: GridStackElement): HTMLElement[];
+    /** convert a potential selector into actual single element */
+    static getElement(els: GridStackElement): HTMLElement;
+    /** returns true if a and b overlap */
+    static isIntercepted(a: GridStackPosition, b: GridStackPosition): boolean;
+    /** returns true if a and b touch edges or corners */
+    static isTouching(a: GridStackPosition, b: GridStackPosition): boolean;
+    /**
+     * Sorts array of nodes
+     * @param nodes array to sort
+     * @param dir 1 for asc, -1 for desc (optional)
+     * @param width width of the grid. If undefined the width will be calculated automatically (optional).
+     **/
+    static sort(nodes: GridStackNode[], dir?: -1 | 1, column?: number): GridStackNode[];
+    /**
+     * creates a style sheet with style id under given parent
+     * @param id will set the 'gs-style-id' attribute to that id
+     * @param parent to insert the stylesheet as first child,
+     * if none supplied it will be appended to the document head instead.
+     */
+    static createStylesheet(id: string, parent?: HTMLElement): CSSStyleSheet;
+    /** removed the given stylesheet id */
+    static removeStylesheet(id: string): void;
+    /** inserts a CSS rule */
+    static addCSSRule(sheet: CSSStyleSheet, selector: string, rules: string): void;
+    static toBool(v: unknown): boolean;
+    static toNumber(value: null | string): number;
+    static parseHeight(val: numberOrString): HeightData;
+    /** copies unset fields in target to use the given default sources values */
+    static defaults(target: any, ...sources: any[]): {};
+    /** given 2 objects return true if they have the same values. Checks for Object {} having same fields and values (just 1 level down) */
+    static same(a: unknown, b: unknown): boolean;
+    /** copies over b size & position (GridStackPosition), and possibly min/max as well */
+    static copyPos(a: GridStackWidget, b: GridStackWidget, minMax?: boolean): GridStackWidget;
+    /** true if a and b has same size & position */
+    static samePos(a: GridStackPosition, b: GridStackPosition): boolean;
+    /** removes field from the first object if same as the second objects (like diffing) and internal '_' for saving */
+    static removeInternalAndSame(a: unknown, b: unknown): void;
+    /** return the closest parent matching the given class */
+    static closestByClass(el: HTMLElement, name: string): HTMLElement;
+    /** delay calling the given function for given delay, preventing new calls from happening while waiting */
+    static throttle(func: () => void, delay: number): () => void;
+    static removePositioningStyles(el: HTMLElement): void;
+    /** single level clone, returning a new object with same top fields. This will share sub objects and arrays */
+    static clone<T>(obj: T): T;
+    /**
+     * Recursive clone version that returns a full copy, checking for nested objects and arrays ONLY.
+     * Note: this will use as-is any key starting with double __ (and not copy inside) some lib have circular dependencies.
+     */
+    static cloneDeep<T>(obj: T): T;
+}