gridstack 5.1.0 → 6.0.1

package/dist/gridstack.js

@@ -12,7 +12,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GridStack = void 0;
 /*!
- * GridStack 5.1.0
+ * GridStack 6.0.1
  * https://gridstackjs.com/
  *
  * Copyright (c) 2021-2022 Alain Dumesny
@@ -20,12 +20,10 @@ exports.GridStack = void 0;
  */
 const gridstack_engine_1 = require("./gridstack-engine");
 const utils_1 = require("./utils");
-const gridstack_ddi_1 = require("./gridstack-ddi");
 // export all dependent file as well to make it easier for users to just import the main file
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./gridstack-engine"), exports);
-__exportStar(require("./gridstack-ddi"), exports);
 // default values for grid options - used during init and when saving out
 const GridDefaults = {
     column: 12,
@@ -45,14 +43,12 @@ const GridDefaults = {
     float: false,
     staticGrid: false,
     animate: true,
-    alwaysShowResizeHandle: false,
+    alwaysShowResizeHandle: 'mobile',
     resizable: {
-        autoHide: true,
         handles: 'se'
     },
     draggable: {
         handle: '.grid-stack-item-content',
-        scroll: false,
         appendTo: 'body'
     },
     disableDrag: false,
@@ -65,7 +61,7 @@ const GridDefaults = {
     marginUnit: 'px',
     cellHeightUnit: 'px',
     disableOneColumnMode: false,
-    oneColumnModeDomSort: false
+    oneColumnModeDomSort: false,
 };
 /**
  * Main gridstack class - you will need to call `GridStack.init()` first to initialize your grid.
@@ -107,16 +103,15 @@ class GridStack {
             opts.oneColumnSize = opts.oneColumnSize || anyOpts.minWidth;
             delete anyOpts.minWidth;
         }
-        // elements attributes override any passed options (like CSS style) - merge the two together
-        let defaults = Object.assign(Object.assign({}, utils_1.Utils.cloneDeep(GridDefaults)), { column: utils_1.Utils.toNumber(el.getAttribute('gs-column')) || 12, minRow: rowAttr ? rowAttr : utils_1.Utils.toNumber(el.getAttribute('gs-min-row')) || 0, maxRow: rowAttr ? rowAttr : utils_1.Utils.toNumber(el.getAttribute('gs-max-row')) || 0, staticGrid: utils_1.Utils.toBool(el.getAttribute('gs-static')) || false, _styleSheetClass: 'grid-stack-instance-' + (Math.random() * 10000).toFixed(0), alwaysShowResizeHandle: opts.alwaysShowResizeHandle || false, resizable: {
-                autoHide: !(opts.alwaysShowResizeHandle || false),
-                handles: 'se'
-            }, draggable: {
-                handle: (opts.handleClass ? '.' + opts.handleClass : (opts.handle ? opts.handle : '')) || '.grid-stack-item-content',
-                scroll: false,
-                appendTo: 'body'
+        // save original setting so we can restore on save
+        if (opts.alwaysShowResizeHandle !== undefined) {
+            opts._alwaysShowResizeHandle = opts.alwaysShowResizeHandle;
+        }
+        // elements DOM attributes override any passed options (like CSS style) - merge the two together
+        let defaults = Object.assign(Object.assign({}, utils_1.Utils.cloneDeep(GridDefaults)), { column: utils_1.Utils.toNumber(el.getAttribute('gs-column')) || GridDefaults.column, minRow: rowAttr ? rowAttr : utils_1.Utils.toNumber(el.getAttribute('gs-min-row')) || GridDefaults.minRow, maxRow: rowAttr ? rowAttr : utils_1.Utils.toNumber(el.getAttribute('gs-max-row')) || GridDefaults.maxRow, staticGrid: utils_1.Utils.toBool(el.getAttribute('gs-static')) || GridDefaults.staticGrid, _styleSheetClass: 'grid-stack-instance-' + (Math.random() * 10000).toFixed(0), draggable: {
+                handle: (opts.handleClass ? '.' + opts.handleClass : (opts.handle ? opts.handle : '')) || GridDefaults.draggable.handle,
             }, removableOptions: {
-                accept: '.' + (opts.itemClass || 'grid-stack-item')
+                accept: opts.itemClass ? '.' + opts.itemClass : GridDefaults.removableOptions.accept,
             } });
         if (el.getAttribute('gs-animate')) { // default to true, but if set to false use that instead
             defaults.animate = utils_1.Utils.toBool(el.getAttribute('gs-animate'));
@@ -156,6 +151,10 @@ class GridStack {
             }
             this.cellHeight(this.opts.cellHeight, false);
         }
+        // see if we need to adjust auto-hide
+        if (this.opts.alwaysShowResizeHandle === 'mobile') {
+            this.opts.alwaysShowResizeHandle = dd_touch_1.isTouch;
+        }
         this.el.classList.add(this.opts._styleSheetClass);
         this._setStaticClass();
         let engineClass = this.opts.engineClass || GridStack.engineClass || gridstack_engine_1.GridStackEngine;
@@ -195,7 +194,7 @@ class GridStack {
                 });
             });
             elements.sort((a, b) => a.i - b.i).forEach(e => this._prepareElement(e.el));
-            this.commit();
+            this.batchUpdate(false);
         }
         this.setAnimation(this.opts.animate);
         this._updateStyles();
@@ -446,6 +445,14 @@ class GridStack {
                 o.column = 'auto';
                 delete o.disableOneColumnMode;
             }
+            const origShow = o._alwaysShowResizeHandle;
+            delete o._alwaysShowResizeHandle;
+            if (origShow !== undefined) {
+                o.alwaysShowResizeHandle = origShow;
+            }
+            else {
+                delete o.alwaysShowResizeHandle;
+            }
             utils_1.Utils.removeInternalAndSame(o, GridDefaults);
             o.children = list;
             return o;
@@ -512,17 +519,23 @@ class GridStack {
             }
         });
         this.engine.removedNodes = removed;
-        this.commit();
+        this.batchUpdate(false);
         // after commit, clear that flag
         delete this._ignoreLayoutsNodeChange;
         delete this._insertNotAppend;
         return this;
     }
     /**
-     * Initializes batch updates. You will see no changes until `commit()` method is called.
+     * use before calling a bunch of `addWidget()` to prevent un-necessary relayouts in between (more efficient)
+     * and get a single event callback. You will see no changes until `batchUpdate(false)` is called.
      */
-    batchUpdate() {
-        this.engine.batchUpdate();
+    batchUpdate(flag = true) {
+        this.engine.batchUpdate(flag);
+        if (!flag) {
+            this._triggerRemoveEvent();
+            this._triggerAddEvent();
+            this._triggerChangeEvent();
+        }
         return this;
     }
     /**
@@ -595,16 +608,6 @@ class GridStack {
         // https://stackoverflow.com/questions/21064101/understanding-offsetwidth-clientwidth-scrollwidth-and-height-respectively
         return (this.el.clientWidth || this.el.parentElement.clientWidth || window.innerWidth);
     }
-    /**
-     * Finishes batch updates. Updates DOM nodes. You must call it after batchUpdate.
-     */
-    commit() {
-        this.engine.commit();
-        this._triggerRemoveEvent();
-        this._triggerAddEvent();
-        this._triggerChangeEvent();
-        return this;
-    }
     /** re-layout grid items to reclaim any empty space */
     compact() {
         this.engine.compact();
@@ -852,7 +855,7 @@ class GridStack {
                 return;
             // remove our DOM data (circular link) and drag&drop permanently
             delete el.gridstackNode;
-            gridstack_ddi_1.GridStackDDI.get().remove(el);
+            this._removeDD(el);
             this.engine.removeNode(node, removeDOM, triggerEvent);
             if (removeDOM && el.parentElement) {
                 el.remove(); // in batch mode engine.removeNode doesn't call back to remove DOM
@@ -872,7 +875,7 @@ class GridStack {
         // always remove our DOM data (circular link) before list gets emptied and drag&drop permanently
         this.engine.nodes.forEach(n => {
             delete n.el.gridstackNode;
-            gridstack_ddi_1.GridStackDDI.get().remove(n.el);
+            this._removeDD(n.el);
         });
         this.engine.removeAll(removeDOM);
         this._triggerRemoveEvent();
@@ -1396,7 +1399,7 @@ class GridStack {
         return this;
     }
     /*
-     * drag&drop empty stubs that will be implemented in gridstack-dd.ts for non static grid
+     * drag&drop empty stubs that will be implemented in dd-gridstack.ts for non static grid
      * so we don't incur the load unless needed.
      * NOTE: had to make those methods public in order to define them else as
      *   GridStack.prototype._setupAcceptWidget = function()
@@ -1408,7 +1411,7 @@ class GridStack {
      * Called during GridStack.init() as options, but can also be called directly (last param are cached) in case the toolbar
      * is dynamically create and needs to change later.
      * @param dragIn string selector (ex: '.sidebar .grid-stack-item')
-     * @param dragInOptions options - see DDDragInOpt. (default: {revert: 'invalid', handle: '.grid-stack-item-content', scroll: false, appendTo: 'body'}
+     * @param dragInOptions options - see DDDragInOpt. (default: {handle: '.grid-stack-item-content', appendTo: 'body'}
      **/
     static setupDragIn(dragIn, dragInOptions) { }
     /**
@@ -1451,6 +1454,8 @@ class GridStack {
      * Enables/disables widget resizing. No-op for static grids.
      */
     enableResize(doEnable) { return this; }
+    /** @internal removes any drag&drop present (called during destroy) */
+    _removeDD(el) { return this; }
     /** @internal called to add drag over support to support widgets */
     _setupAcceptWidget() { return this; }
     /** @internal called to setup a trash drop zone if the user specifies it */
@@ -1463,10 +1468,15 @@ class GridStack {
     _dragOrResize(el, event, ui, node, cellWidth, cellHeight) { return; }
     /** @internal called when a node leaves our area (mouse out or shape outside) **/
     _leave(el, helper) { return; }
+    // legacy method removed
+    commit() { utils_1.obsolete(this, this.batchUpdate(false), 'commit', 'batchUpdate', '5.2'); return this; }
 }
 exports.GridStack = GridStack;
 /** scoping so users can call GridStack.Utils.sort() for example */
 GridStack.Utils = utils_1.Utils;
 /** scoping so users can call new GridStack.Engine(12) for example */
 GridStack.Engine = gridstack_engine_1.GridStackEngine;
+GridStack.GDRev = '6.0.1';
+const dd_touch_1 = require("./dd-touch");
+__exportStar(require("./dd-gridstack"), exports);
 //# sourceMappingURL=gridstack.js.map