Merge pull request gridstack#2085 from adumesny/master

adumesny · web-flow · commit 1b740cbbfc4f · 2022-10-17T08:29:02.000-07:00
added GridStackEngine.findEmptyPosition()
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
@@ -77,7 +77,7 @@ Change log
 
 ## 7.0.2 (TBD)
 * fixed [#2081](https://github.com/gridstack/gridstack.js/issues/2081) removeWidget() after it's gone from DOM
-
+* add GridStackEngine.findEmptyPosition()
 ## 7.0.1 (2022-10-14)
 * fixed [#2073](https://github.com/gridstack/gridstack.js/issues/2073) SSR (server side rendering) isTouch issue (introduced in v6)
 * fixed - removing last item delete sub-grid that are not auto-generated (nested.html vs nested_advanced.html)
diff --git a/src/gridstack-engine.ts b/src/gridstack-engine.ts
@@ -470,6 +470,26 @@ export class GridStackEngine {
     return this;
   }
 
+  /** find the first available empty spot for the given node width/height, updating the x,y attributes. return true if found */
+  public findEmptyPosition(node: GridStackNode): boolean {
+    this.sortNodes();
+    let found = false;
+    for (let i = 0; !found; ++i) {
+      let x = i % this.column;
+      let y = Math.floor(i / this.column);
+      if (x + node.w > this.column) {
+        continue;
+      }
+      let box = {x, y, w: node.w, h: node.h};
+      if (!this.nodes.find(n => Utils.isIntercepted(box, n))) {
+        node.x = x;
+        node.y = y;
+        found = true;
+      }
+    }
+    return found;
+  }
+
   /** call to add the given node to our list, fixing collision and re-packing */
   public addNode(node: GridStackNode, triggerAddEvent = false): GridStackNode {
     let dup = this.nodes.find(n => n._id === node._id);
@@ -480,23 +500,8 @@ export class GridStackEngine {
     delete node._temporaryRemoved;
     delete node._removeDOM;
 
-    if (node.autoPosition) {
-      this.sortNodes();
-
-      for (let i = 0;; ++i) {
-        let x = i % this.column;
-        let y = Math.floor(i / this.column);
-        if (x + node.w > this.column) {
-          continue;
-        }
-        let box = {x, y, w: node.w, h: node.h};
-        if (!this.nodes.find(n => Utils.isIntercepted(box, n))) {
-          node.x = x;
-          node.y = y;
-          delete node.autoPosition; // found our slot
-          break;
-        }
-      }
+    if (node.autoPosition && this.findEmptyPosition(node)) {
+      delete node.autoPosition; // found our slot
     }
 
     this.nodes.push(node);
diff --git a/src/gridstack.ts b/src/gridstack.ts
@@ -378,16 +378,6 @@ export class GridStack {
    * @param options widget position/size options (optional, and ignore if first param is already option) - see GridStackWidget
    */
   public addWidget(els?: GridStackWidget | GridStackElement, options?: GridStackWidget): GridItemHTMLElement {
-    // support legacy call for now ?
-    if (arguments.length > 2) {
-      console.warn('gridstack.ts: `addWidget(el, x, y, width...)` is deprecated. Use `addWidget({x, y, w, content, ...})`. It will be removed soon');
-      // eslint-disable-next-line prefer-rest-params
-      let a = arguments, i = 1,
-        opt: GridStackWidget = { x:a[i++], y:a[i++], w:a[i++], h:a[i++], autoPosition:a[i++],
-          minW:a[i++], maxW:a[i++], minH:a[i++], maxH:a[i++], id:a[i++] };
-      return this.addWidget(els, opt);
-    }
-
     function isGridStackWidget(w: GridStackWidget): w is GridStackWidget { // https://medium.com/ovrsea/checking-the-type-of-an-object-in-typescript-the-type-guards-24d98d9119b0
       return w.x !== undefined || w.y !== undefined || w.w !== undefined || w.h !== undefined || w.content !== undefined ? true : false;
     }
