Merge pull request gridstack#2068 from adumesny/master

adumesny · web-flow · commit 82d15f22b010 · 2022-10-09T09:17:57.000-07:00
doc update
diff --git a/doc/README.md b/doc/README.md
@@ -153,7 +153,8 @@ You need to add `noResize` and `noMove` attributes to completely lock the widget
 - `resizeHandles` - 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
 - `id`- (number | string) good for quick identification (for example in change event)
 - `content` - (string) html content to be added when calling `grid.load()/addWidget()` as content inside the item
-- `subGrid`: GridStackOptions - optional nested grid options and list of children
+- `subGrid`?: GridStackOptions - optional nested grid options and list of children
+- `subGridDynamic`?: boolean - enable/disable the creation of sub-grids on the fly by dragging items completely over others (nest) vs partially (push). Forces `DDDragOpt.pause=true` to accomplish that.
 
 ## Item attributes
 
diff --git a/src/types.ts b/src/types.ts
@@ -241,7 +241,8 @@ export interface GridStackOptions {
   /** list of differences in options for automatically created sub-grids under us */
   subGrid?: GridStackOptions;
 
-  /** enable/disable the creation of sub-grids on the fly (drop over other items) */
+  /** enable/disable the creation of sub-grids on the fly by dragging items completely
+   * over others (nest) vs partially (push). Forces `DDDragOpt.pause=true` to accomplish that. */
   subGridDynamic?: boolean;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,8 @@ export interface GridStackOptions {`
`241`	`241`	`/** list of differences in options for automatically created sub-grids under us */`
`242`	`242`	`subGrid?: GridStackOptions;`
`243`	`243`
`244`		`- /** enable/disable the creation of sub-grids on the fly (drop over other items) */`
	`244`	`+ /** enable/disable the creation of sub-grids on the fly by dragging items completely`
	`245`	+ * over others (nest) vs partially (push). Forces `DDDragOpt.pause=true` to accomplish that. */
`245`	`246`	`subGridDynamic?: boolean;`
`246`	`247`	`}`
`247`	`248`