gridstack 4.4.1 → 5.1.1

package/dist/es5/gridstack.d.ts

@@ -1,8 +1,8 @@
 /*!
- * GridStack 4.4.1
+ * GridStack 5.1.1
  * https://gridstackjs.com/
  *
- * Copyright (c) 2021 Alain Dumesny
+ * Copyright (c) 2021-2022 Alain Dumesny
  * see root license https://github.com/gridstack/gridstack.js/tree/master/LICENSE
  */
 import { GridStackEngine } from './gridstack-engine';
@@ -70,6 +70,11 @@ export declare class GridStack {
      * @param opt grids options used to initialize the grid, and list of children
      */
     static addGrid(parent: HTMLElement, opt?: GridStackOptions): GridStack;
+    /** call this method to register your engine instead of the default one.
+     * See instead `GridStackOptions.engineClass` if you only need to
+     * replace just one instance.
+     */
+    static registerEngine(engineClass: typeof GridStackEngine): void;
     /** scoping so users can call GridStack.Utils.sort() for example */
     static Utils: typeof Utils;
     /** scoping so users can call new GridStack.Engine(12) for example */
@@ -80,6 +85,7 @@ export declare class GridStack {
     engine: GridStackEngine;
     /** grid options - public for classes to access, but use methods to modify! */
     opts: GridStackOptions;
+    protected static engineClass: typeof GridStackEngine;
     /**
      * Construct a grid item from the given element and options
      * @param el
@@ -149,7 +155,7 @@ export declare class GridStack {
     /** Gets current cell width. */
     cellWidth(): number;
     /** return our expected width (or parent) for 1 column check */
-    private _widthOrContainer;
+    protected _widthOrContainer(): number;
     /**
      * Finishes batch updates. Updates DOM nodes. You must call it after batchUpdate.
      */
@@ -290,11 +296,11 @@ export declare class GridStack {
     willItFit(node: GridStackWidget): boolean;
     /**
      * called when we are being resized by the window - check if the one Column Mode needs to be turned on/off
-     * and remember the prev columns we used, as well as check for auto cell height (square)
+     * and remember the prev columns we used, or get our count from parent, as well as check for auto cell height (square)
      */
     onParentResize(): GridStack;
     /** add or remove the window size event handler */
-    private _updateWindowResizeEvent;
+    protected _updateWindowResizeEvent(forceRemove?: boolean): GridStack;
     /**
      * call to setup dragging in from the outside (say toolbar), by specifying the class selection and options.
      * Called during GridStack.init() as options, but can also be called directly (last param are cached) in case the toolbar

package/dist/es5/gridstack.js

@@ -30,10 +30,10 @@ var __spreadArrays = (this && this.__spreadArrays) || function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GridStack = void 0;
 /*!
- * GridStack 4.4.1
+ * GridStack 5.1.1
  * https://gridstackjs.com/
  *
- * Copyright (c) 2021 Alain Dumesny
+ * Copyright (c) 2021-2022 Alain Dumesny
  * see root license https://github.com/gridstack/gridstack.js/tree/master/LICENSE
  */
 var gridstack_engine_1 = require("./gridstack-engine");
@@ -59,7 +59,7 @@ var GridDefaults = {
     cellHeightThrottle: 100,
     margin: 10,
     auto: true,
-    minWidth: 768,
+    oneColumnSize: 768,
     float: false,
     staticGrid: false,
     animate: true,
@@ -116,6 +116,17 @@ var GridStack = /** @class */ (function () {
             delete opts.row;
         }
         var rowAttr = utils_1.Utils.toNumber(el.getAttribute('gs-row'));
+        // flag only valid in sub-grids (handled by parent, not here)
+        if (opts.column === 'auto') {
+            delete opts.column;
+        }
+        // 'minWidth' legacy support in 5.1
+        /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+        var anyOpts = opts;
+        if (anyOpts.minWidth !== undefined) {
+            opts.oneColumnSize = opts.oneColumnSize || anyOpts.minWidth;
+            delete anyOpts.minWidth;
+        }
         // elements attributes override any passed options (like CSS style) - merge the two together
         var defaults = __assign(__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),
@@ -132,10 +143,10 @@ var GridStack = /** @class */ (function () {
         }
         this.opts = utils_1.Utils.defaults(opts, defaults);
         opts = null; // make sure we use this.opts instead
-        this.initMargin(); // part of settings defaults...
+        this._initMargin(); // part of settings defaults...
         // Now check if we're loading into 1 column mode FIRST so we don't do un-necessary work (like cellHeight = width / 12 then go 1 column)
-        if (this.opts.column !== 1 && !this.opts.disableOneColumnMode && this._widthOrContainer() <= this.opts.minWidth) {
-            this._prevColumn = this.opts.column;
+        if (this.opts.column !== 1 && !this.opts.disableOneColumnMode && this._widthOrContainer() <= this.opts.oneColumnSize) {
+            this._prevColumn = this.getColumn();
             this.opts.column = 1;
         }
         if (this.opts.rtl === 'auto') {
@@ -149,6 +160,7 @@ var GridStack = /** @class */ (function () {
         if (parentGridItemEl && parentGridItemEl.gridstackNode) {
             this.opts._isNested = parentGridItemEl.gridstackNode;
             this.opts._isNested.subGrid = this;
+            parentGridItemEl.classList.add('grid-stack-nested');
             this.el.classList.add('grid-stack-nested');
         }
         this._isAutoCellHeight = (this.opts.cellHeight === 'auto');
@@ -166,8 +178,9 @@ var GridStack = /** @class */ (function () {
         }
         this.el.classList.add(this.opts._styleSheetClass);
         this._setStaticClass();
-        this.engine = new gridstack_engine_1.GridStackEngine({
-            column: this.opts.column,
+        var engineClass = this.opts.engineClass || GridStack.engineClass || gridstack_engine_1.GridStackEngine;
+        this.engine = new engineClass({
+            column: this.getColumn(),
             float: this.opts.float,
             maxRow: this.opts.maxRow,
             onChange: function (cbNodes) {
@@ -198,7 +211,7 @@ var GridStack = /** @class */ (function () {
                 elements_1.push({
                     el: el,
                     // if x,y are missing (autoPosition) add them to end of list - but keep their respective DOM order
-                    i: (Number.isNaN(x) ? 1000 : x) + (Number.isNaN(y) ? 1000 : y) * _this.opts.column
+                    i: (Number.isNaN(x) ? 1000 : x) + (Number.isNaN(y) ? 1000 : y) * _this.getColumn()
                 });
             });
             elements_1.sort(function (a, b) { return a.i - b.i; }).forEach(function (e) { return _this._prepareElement(e.el); });
@@ -305,6 +318,13 @@ var GridStack = /** @class */ (function () {
         }
         return grid;
     };
+    /** call this method to register your engine instead of the default one.
+     * See instead `GridStackOptions.engineClass` if you only need to
+     * replace just one instance.
+     */
+    GridStack.registerEngine = function (engineClass) {
+        GridStack.engineClass = engineClass;
+    };
     Object.defineProperty(GridStack.prototype, "placeholder", {
         /** @internal create placeholder DIV as needed */
         get: function () {
@@ -385,8 +405,19 @@ var GridStack = /** @class */ (function () {
         this._updateContainerHeight();
         // check if nested grid definition is present
         if (node.subGrid && !node.subGrid.el) { // see if there is a sub-grid to create too
+            // if column special case it set, remember that flag and set default
+            var autoColumn = void 0;
+            var ops = node.subGrid;
+            if (ops.column === 'auto') {
+                ops.column = node.w;
+                ops.disableOneColumnMode = true; // driven by parent
+                autoColumn = true;
+            }
             var content = node.el.querySelector('.grid-stack-item-content');
             node.subGrid = GridStack.addGrid(content, node.subGrid);
+            if (autoColumn) {
+                node.subGrid._autoColumn = true;
+            }
         }
         this._triggerAddEvent();
         this._triggerChangeEvent();
@@ -442,6 +473,10 @@ var GridStack = /** @class */ (function () {
             if (this._isAutoCellHeight) {
                 o.cellHeight = 'auto';
             }
+            if (this._autoColumn) {
+                o.column = 'auto';
+                delete o.disableOneColumnMode;
+            }
             utils_1.Utils.removeInternalAndSame(o, GridDefaults);
             o.children = list;
             return o;
@@ -461,7 +496,7 @@ var GridStack = /** @class */ (function () {
     GridStack.prototype.load = function (layout, addAndRemove) {
         var _this = this;
         if (addAndRemove === void 0) { addAndRemove = true; }
-        var items = GridStack.Utils.sort(__spreadArrays(layout), -1, this._prevColumn || this.opts.column); // make copy before we mod/sort
+        var items = GridStack.Utils.sort(__spreadArrays(layout), -1, this._prevColumn || this.getColumn()); // make copy before we mod/sort
         this._insertNotAppend = true; // since create in reverse order...
         // if we're loading a layout into 1 column (_prevColumn is set only when going to 1) and items don't fit, make sure to save
         // the original wanted layout so we can scale back up correctly #1471
@@ -532,12 +567,15 @@ var GridStack = /** @class */ (function () {
             (!forcePixel || !this.opts.cellHeightUnit || this.opts.cellHeightUnit === 'px')) {
             return this.opts.cellHeight;
         }
-        // else do entire grid and # of rows
-        // or get first cell height ?
-        // let el = this.el.querySelector('.' + this.opts.itemClass) as HTMLElement;
-        // let height = Utils.toNumber(el.getAttribute('gs-h'));
-        // return Math.round(el.offsetHeight / height);
-        return Math.round(this.el.getBoundingClientRect().height) / parseInt(this.el.getAttribute('gs-current-row'));
+        // else get first cell height
+        var el = this.el.querySelector('.' + this.opts.itemClass);
+        if (el) {
+            var height = utils_1.Utils.toNumber(el.getAttribute('gs-h'));
+            return Math.round(el.offsetHeight / height);
+        }
+        // else do entire grid and # of rows (but doesn't work if min-height is the actual constrain)
+        var rows = parseInt(this.el.getAttribute('gs-current-row'));
+        return rows ? Math.round(this.el.getBoundingClientRect().height / rows) : this.opts.cellHeight;
     };
     /**
      * Update current cell height - see `GridStackOptions.cellHeight` for format.
@@ -584,7 +622,7 @@ var GridStack = /** @class */ (function () {
     };
     /** Gets current cell width. */
     GridStack.prototype.cellWidth = function () {
-        return this._widthOrContainer() / this.opts.column;
+        return this._widthOrContainer() / this.getColumn();
     };
     /** return our expected width (or parent) for 1 column check */
     GridStack.prototype._widthOrContainer = function () {
@@ -621,7 +659,7 @@ var GridStack = /** @class */ (function () {
         if (layout === void 0) { layout = 'moveScale'; }
         if (column < 1 || this.opts.column === column)
             return this;
-        var oldColumn = this.opts.column;
+        var oldColumn = this.getColumn();
         // if we go into 1 column mode (which happens if we're sized less than minW unless disableOneColumnMode is on)
         // then remember the original columns so we can restore.
         if (column === 1) {
@@ -733,7 +771,7 @@ var GridStack = /** @class */ (function () {
         }
         var relativeLeft = position.left - containerPos.left;
         var relativeTop = position.top - containerPos.top;
-        var columnWidth = (box.width / this.opts.column);
+        var columnWidth = (box.width / this.getColumn());
         var rowHeight = (box.height / parseInt(this.el.getAttribute('gs-current-row')));
         return { x: Math.floor(relativeLeft / columnWidth), y: Math.floor(relativeTop / rowHeight) };
     };
@@ -1003,7 +1041,7 @@ var GridStack = /** @class */ (function () {
         // re-use existing margin handling
         this.opts.margin = value;
         this.opts.marginTop = this.opts.marginBottom = this.opts.marginLeft = this.opts.marginRight = undefined;
-        this.initMargin();
+        this._initMargin();
         this._updateStyles(true); // true = force re-create
         return this;
     };
@@ -1149,13 +1187,15 @@ var GridStack = /** @class */ (function () {
             return this;
         var row = this.getRow() + this._extraDragRow; // checks for minRow already
         // check for css min height
-        var cssMinHeight = parseInt(getComputedStyle(this.el)['min-height']);
-        if (cssMinHeight > 0) {
-            var minRow = Math.round(cssMinHeight / this.getCellHeight(true));
-            if (row < minRow) {
-                row = minRow;
-            }
-        }
+        // Note: we don't handle %,rem correctly so comment out, beside we don't need need to create un-necessary
+        // rows as the CSS will make us bigger than our set height if needed... not sure why we had this.
+        // let cssMinHeight = parseInt(getComputedStyle(this.el)['min-height']);
+        // if (cssMinHeight > 0) {
+        //   let minRow = Math.round(cssMinHeight / this.getCellHeight(true));
+        //   if (row < minRow) {
+        //     row = minRow;
+        //   }
+        // }
         this.el.setAttribute('gs-current-row', String(row));
         if (row === 0) {
             this.el.style.removeProperty('height');
@@ -1273,34 +1313,44 @@ var GridStack = /** @class */ (function () {
     };
     /**
      * called when we are being resized by the window - check if the one Column Mode needs to be turned on/off
-     * and remember the prev columns we used, as well as check for auto cell height (square)
+     * and remember the prev columns we used, or get our count from parent, as well as check for auto cell height (square)
      */
     GridStack.prototype.onParentResize = function () {
         var _this = this;
         if (!this.el || !this.el.clientWidth)
             return; // return if we're gone or no size yet (will get called again)
-        var oneColumn = !this.opts.disableOneColumnMode && this.el.clientWidth <= this.opts.minWidth;
-        var changedOneColumn = false;
-        if ((this.opts.column === 1) !== oneColumn) {
-            changedOneColumn = true;
-            if (this.opts.animate) {
-                this.setAnimation(false);
-            } // 1 <-> 12 is too radical, turn off animation
-            this.column(oneColumn ? 1 : this._prevColumn);
-            if (this.opts.animate) {
-                this.setAnimation(true);
+        var changedColumn = false;
+        // see if we're nested and take our column count from our parent....
+        if (this._autoColumn && this.opts._isNested) {
+            if (this.opts.column !== this.opts._isNested.w) {
+                changedColumn = true;
+                this.column(this.opts._isNested.w, 'none');
+            }
+        }
+        else {
+            // else check for 1 column in/out behavior
+            var oneColumn = !this.opts.disableOneColumnMode && this.el.clientWidth <= this.opts.oneColumnSize;
+            if ((this.opts.column === 1) !== oneColumn) {
+                changedColumn = true;
+                if (this.opts.animate) {
+                    this.setAnimation(false);
+                } // 1 <-> 12 is too radical, turn off animation
+                this.column(oneColumn ? 1 : this._prevColumn);
+                if (this.opts.animate) {
+                    this.setAnimation(true);
+                }
             }
         }
         // make the cells content square again
         if (this._isAutoCellHeight) {
-            if (!changedOneColumn && this.opts.cellHeightThrottle) {
+            if (!changedColumn && this.opts.cellHeightThrottle) {
                 if (!this._cellHeightThrottle) {
                     this._cellHeightThrottle = utils_1.Utils.throttle(function () { return _this.cellHeight(); }, this.opts.cellHeightThrottle);
                 }
                 this._cellHeightThrottle();
             }
             else {
-                // immediate update if we've changed to/from oneColumn or have no threshold
+                // immediate update if we've changed column count or have no threshold
                 this.cellHeight();
             }
         }
@@ -1342,7 +1392,7 @@ var GridStack = /** @class */ (function () {
     /** @internal */
     GridStack.getGridElements = function (els) { return utils_1.Utils.getElements(els); };
     /** @internal initialize margin top/bottom/left/right and units */
-    GridStack.prototype.initMargin = function () {
+    GridStack.prototype._initMargin = function () {
         var data;
         var margin = 0;
         // support passing multiple values like CSS (ex: '5px 10px 0 20px')