gridstack 11.3.0 → 11.5.0

package/dist/gridstack.js

@@ -1,5 +1,5 @@
 /*!
- * GridStack 11.3.0
+ * GridStack 11.5.0
  * https://gridstackjs.com/
  *
  * Copyright (c) 2021-2024  Alain Dumesny
@@ -355,7 +355,7 @@ class GridStack {
             el = GridStack.addRemoveCB(this.el, w, true, false);
         }
         else {
-            el = Utils.createWidgetDivs(this.opts.itemClass, node);
+            el = this.createWidgetDivs(node);
         }
         if (!el)
             return;
@@ -374,6 +374,27 @@ class GridStack {
         this.makeWidget(el, w);
         return el;
     }
+    /** create the default grid item divs, and content (possibly lazy loaded) by using GridStack.renderCB() */
+    createWidgetDivs(n) {
+        const el = Utils.createDiv(['grid-stack-item', this.opts.itemClass]);
+        const cont = Utils.createDiv(['grid-stack-item-content'], el);
+        if (Utils.lazyLoad(n)) {
+            if (!n.visibleObservable) {
+                n.visibleObservable = new IntersectionObserver(([entry]) => {
+                    if (entry.isIntersecting) {
+                        n.visibleObservable?.disconnect();
+                        delete n.visibleObservable;
+                        GridStack.renderCB(cont, n);
+                        n.grid?.prepareDragDrop(n.el);
+                    }
+                });
+                window.setTimeout(() => n.visibleObservable?.observe(el)); // wait until callee sets position attributes
+            }
+        }
+        else
+            GridStack.renderCB(cont, n);
+        return el;
+    }
     /**
      * Convert an existing gridItem element into a sub-grid with the given (optional) options, else inherit them
      * from the parent's subGrid options.
@@ -433,7 +454,7 @@ class GridStack {
                 newItem.appendChild(content);
                 content = Utils.createDiv(['grid-stack-item-content'], node.el);
             }
-            this._prepareDragDropByNode(node); // ... and restore original D&D
+            this.prepareDragDrop(node.el); // ... and restore original D&D
         }
         // if we're adding an additional item, make the container large enough to have them both
         if (nodeToAdd) {
@@ -562,8 +583,8 @@ class GridStack {
     /**
      * load the widgets from a list. This will call update() on each (matching by id) or add/remove widgets that are not there.
      *
-     * @param layout list of widgets definition to update/create
-     * @param addAndRemove boolean (default true) or callback method can be passed to control if and how missing widgets can be added/removed, giving
+     * @param items list of widgets definition to update/create
+     * @param addRemove boolean (default true) or callback method can be passed to control if and how missing widgets can be added/removed, giving
      * the user control of insertion.
      *
      * @example
@@ -1117,7 +1138,7 @@ class GridStack {
         this._setupRemoveDrop();
         this._setupAcceptWidget();
         this.engine.nodes.forEach(n => {
-            this._prepareDragDropByNode(n); // either delete or init Drag&drop
+            this.prepareDragDrop(n.el); // either delete or init Drag&drop
             if (n.subGrid && recurse)
                 n.subGrid.setStatic(val, updateClass, recurse);
         });
@@ -1126,26 +1147,64 @@ class GridStack {
         }
         return this;
     }
+    /**
+     * Updates the passed in options on the grid (similar to update(widget) for for the grid options).
+     * @param options PARTIAL grid options to update - only items specified will be updated.
+     * NOTE: not all options updating are currently supported (lot of code, unlikely to change)
+     */
+    updateOptions(o) {
+        const opts = this.opts;
+        if (o.acceptWidgets !== undefined)
+            this._setupAcceptWidget();
+        if (o.animate !== undefined)
+            this.setAnimation();
+        if (o.cellHeight) {
+            this.cellHeight(o.cellHeight, true);
+            delete o.cellHeight;
+        }
+        if (o.class && o.class !== opts.class) {
+            if (opts.class)
+                this.el.classList.remove(opts.class);
+            this.el.classList.add(o.class);
+        }
+        if (typeof (o.column) === 'number' && !o.columnOpts) {
+            this.column(o.column);
+            delete o.column;
+        } // responsive column take over actual count
+        if (o.margin !== undefined)
+            this.margin(o.margin);
+        if (o.staticGrid !== undefined)
+            this.setStatic(o.staticGrid);
+        if (o.disableDrag !== undefined && !o.staticGrid)
+            this.enableMove(!o.disableDrag);
+        if (o.disableResize !== undefined && !o.staticGrid)
+            this.enableResize(!o.disableResize);
+        if (o.float !== undefined)
+            this.float(o.float);
+        if (o.row !== undefined) {
+            opts.minRow = opts.maxRow = o.row;
+        }
+        if (o.children?.length) {
+            this.load(o.children);
+            delete o.children;
+        }
+        // TBD if we have a real need for these (more complex code)
+        // alwaysShowResizeHandle, draggable, handle, handleClass, itemClass, layout, placeholderClass, placeholderText, resizable, removable, row,...
+        // rest are just copied over...
+        this.opts = { ...this.opts, ...o };
+        return this;
+    }
     /**
      * Updates widget position/size and other info. Note: if you need to call this on all nodes, use load() instead which will update what changed.
      * @param els  widget or selector of objects to modify (note: setting the same x,y for multiple items will be indeterministic and likely unwanted)
      * @param opt new widget options (x,y,w,h, etc..). Only those set will be updated.
      */
     update(els, opt) {
-        // support legacy call for now ?
-        if (arguments.length > 2) {
-            console.warn('gridstack.ts: `update(el, x, y, w, h)` is deprecated. Use `update(el, {x, w, content, ...})`. It will be removed soon');
-            // eslint-disable-next-line prefer-rest-params
-            const a = arguments;
-            let i = 1;
-            opt = { x: a[i++], y: a[i++], w: a[i++], h: a[i++] };
-            return this.update(els, opt);
-        }
         GridStack.getElements(els).forEach(el => {
             const n = el?.gridstackNode;
             if (!n)
                 return;
-            const w = Utils.cloneDeep(opt); // make a copy we can modify in case they re-use it or multiple items
+            const w = { ...Utils.copyPos({}, n), ...Utils.cloneDeep(opt) }; // make a copy we can modify in case they re-use it or multiple items
             this.engine.nodeBoundFix(w);
             delete w.autoPosition;
             // move/resize widget if anything changed
@@ -1205,7 +1264,7 @@ class GridStack {
                 this._writeAttr(el, n);
             }
             if (ddChanged) {
-                this._prepareDragDropByNode(n);
+                this.prepareDragDrop(n.el);
             }
         });
         return this;
@@ -1531,7 +1590,8 @@ class GridStack {
         sizeToContent ? el.classList.add('size-to-content') : el.classList.remove('size-to-content');
         if (sizeToContent)
             this.resizeToContentCheck(false, node);
-        this._prepareDragDropByNode(node);
+        if (!Utils.lazyLoad(node))
+            this.prepareDragDrop(node.el);
         return this;
     }
     /** @internal call to write position x,y,w,h attributes back to element */
@@ -1580,7 +1640,13 @@ class GridStack {
         n.noResize = Utils.toBool(el.getAttribute('gs-no-resize'));
         n.noMove = Utils.toBool(el.getAttribute('gs-no-move'));
         n.locked = Utils.toBool(el.getAttribute('gs-locked'));
-        n.sizeToContent = Utils.toBool(el.getAttribute('gs-size-to-content'));
+        const attr = el.getAttribute('gs-size-to-content');
+        if (attr) {
+            if (attr === 'true' || attr === 'false')
+                n.sizeToContent = Utils.toBool(attr);
+            else
+                n.sizeToContent = parseInt(attr, 10);
+        }
         n.id = el.getAttribute('gs-id');
         // read but never written out
         n.maxW = Utils.toNumber(el.getAttribute('gs-max-w'));
@@ -1602,11 +1668,11 @@ class GridStack {
             if (n.minH)
                 el.removeAttribute('gs-min-h');
         }
-        // remove any key not found (null or false which is default)
+        // remove any key not found (null or false which is default, unless sizeToContent=false override)
         for (const key in n) {
             if (!n.hasOwnProperty(key))
                 return;
-            if (!n[key] && n[key] !== 0) { // 0 can be valid value (x,y only really)
+            if (!n[key] && n[key] !== 0 && key !== 'gs-size-to-content') { // 0 can be valid value (x,y only really)
                 delete n[key];
             }
         }
@@ -1824,7 +1890,7 @@ class GridStack {
             if (!n)
                 return;
             val ? delete n.noMove : n.noMove = true;
-            this._prepareDragDropByNode(n); // init DD if need be, and adjust
+            this.prepareDragDrop(n.el); // init DD if need be, and adjust
         });
         return this;
     }
@@ -1841,7 +1907,7 @@ class GridStack {
             if (!n)
                 return;
             val ? delete n.noResize : n.noResize = true;
-            this._prepareDragDropByNode(n); // init DD if need be, and adjust
+            this.prepareDragDrop(n.el); // init DD if need be, and adjust
         });
         return this;
     }
@@ -1889,7 +1955,7 @@ class GridStack {
             return this; // can't move a static grid!
         doEnable ? delete this.opts.disableDrag : this.opts.disableDrag = true; // FIRST before we update children as grid overrides #1658
         this.engine.nodes.forEach(n => {
-            this._prepareDragDropByNode(n);
+            this.prepareDragDrop(n.el);
             if (n.subGrid && recurse)
                 n.subGrid.enableMove(doEnable, recurse);
         });
@@ -1904,7 +1970,7 @@ class GridStack {
             return this; // can't size a static grid!
         doEnable ? delete this.opts.disableResize : this.opts.disableResize = true; // FIRST before we update children as grid overrides #1658
         this.engine.nodes.forEach(n => {
-            this._prepareDragDropByNode(n);
+            this.prepareDragDrop(n.el);
             if (n.subGrid && recurse)
                 n.subGrid.enableResize(doEnable, recurse);
         });
@@ -2032,6 +2098,11 @@ class GridStack {
                 // delete node._added; // reset this to track placeholder again in case we were over other grid #1484 (dropout doesn't always clear)
                 return false; // prevent parent from receiving msg (which may be a grid as well)
             }
+            // If sidebar item, restore the sidebar node size to ensure consistent behavior when dragging between grids
+            if (node?._sidebarOrig) {
+                node.w = node._sidebarOrig.w;
+                node.h = node._sidebarOrig.h;
+            }
             // fix #1578 when dragging fast, we may not get a leave on the previous grid so force one now
             if (node?.grid && node.grid !== this && !node._temporaryRemoved) {
                 // console.log('dropover without leave'); // TEST
@@ -2042,7 +2113,7 @@ class GridStack {
             // cache cell dimensions (which don't change), position can animate if we removed an item in otherGrid that affects us...
             cellWidth = this.cellWidth();
             cellHeight = this.getCellHeight(true);
-            // sidebar items: load any element attributes if we don't have a node
+            // sidebar items: load any element attributes if we don't have a node on first enter from the sidebar
             if (!node) {
                 const attr = helper.getAttribute('data-gs-widget') || helper.getAttribute('gridstacknode'); // TBD: temp support for old V11.0.0 attribute
                 if (attr) {
@@ -2057,6 +2128,8 @@ class GridStack {
                 }
                 if (!node)
                     node = this._readAttr(helper); // used to pass false for #2354, but now we clone top level node
+                // On first grid enter from sidebar, set the initial sidebar item size properties for the node
+                node._sidebarOrig = { w: node.w, h: node.h };
             }
             if (!node.grid) { // sidebar item
                 if (!node.el)
@@ -2225,19 +2298,28 @@ class GridStack {
         }
         return this;
     }
-    /** @internal prepares the element for drag&drop */
-    _prepareDragDropByNode(node) {
-        const el = node.el;
+    /**
+     * prepares the element for drag&drop - this is normally called by makeWidget() unless are are delay loading
+     * @param el GridItemHTMLElement of the widget
+     * @param [force=false]
+     * */
+    prepareDragDrop(el, force = false) {
+        const node = el?.gridstackNode;
+        if (!node)
+            return;
         const noMove = node.noMove || this.opts.disableDrag;
         const noResize = node.noResize || this.opts.disableResize;
         // check for disabled grid first
-        if (this.opts.staticGrid || (noMove && noResize)) {
+        const disable = node.locked || this.opts.staticGrid || (noMove && noResize);
+        if (force || disable) {
             if (node._initDD) {
                 this._removeDD(el); // nukes everything instead of just disable, will add some styles back next
                 delete node._initDD;
             }
-            el.classList.add('ui-draggable-disabled', 'ui-resizable-disabled'); // add styles one might depend on #1435
-            return this;
+            if (disable) {
+                el.classList.add('ui-draggable-disabled', 'ui-resizable-disabled'); // add styles one might depend on #1435
+                return this;
+            }
         }
         if (!node._initDD) {
             // variables used/cashed between the 3 start/move/end methods, in addition to node passed above
@@ -2452,7 +2534,10 @@ class GridStack {
             this._extraDragRow = 0; // @ts-ignore
             this._updateContainerHeight();
             const target = event.target; // @ts-ignore
-            this._writePosAttr(target, node);
+            // Do not write sidebar item attributes back to the original sidebar el
+            if (!node._sidebarOrig) {
+                this._writePosAttr(target, node);
+            }
             if (this._gsEventHandler[event.type]) {
                 this._gsEventHandler[event.type](event, target);
             }
@@ -2476,8 +2561,11 @@ class GridStack {
         node._temporaryRemoved = true;
         this.engine.removeNode(node); // remove placeholder as well, otherwise it's a sign node is not in our list, which is a bigger issue
         node.el = node._isExternal && helper ? helper : el; // point back to real item being dragged
+        const sidebarOrig = node._sidebarOrig;
         if (node._isExternal)
             this.engine.cleanupNode(node);
+        // Restore sidebar item initial size info to stay consistent when dragging between multiple grids
+        node._sidebarOrig = sidebarOrig;
         if (this.opts.removable === true) { // boolean vs a class string
             // item leaving us and we are supposed to remove on leave (no need to drag onto trash) mark it so
             GridStack._itemRemoving(el, true);
@@ -2508,6 +2596,6 @@ GridStack.resizeToContentParent = '.grid-stack-item-content';
 GridStack.Utils = Utils;
 /** scoping so users can call new GridStack.Engine(12) for example */
 GridStack.Engine = GridStackEngine;
-GridStack.GDRev = '11.3.0';
+GridStack.GDRev = '11.5.0';
 export { GridStack };
 //# sourceMappingURL=gridstack.js.map