diff --git a/doc/CHANGES.md b/doc/CHANGES.md index ff92fde3d..9281126e7 100644 --- a/doc/CHANGES.md +++ b/doc/CHANGES.md @@ -45,6 +45,7 @@ Change log You can now have perfect square cells (default) [723](https://github.com/gridstack/gridstack.js/issues/723) - fix [1299](https://github.com/gridstack/gridstack.js/pull/1299) many columns round-off error - fix [1102](https://github.com/gridstack/gridstack.js/issues/1102) loose functionality when they are moved to a new grid +- add optional params to `removeWidget()` to have quiet mode (no callbacks) ## 1.2.0 (2020-08-01) diff --git a/doc/README.md b/doc/README.md index ffe5fba2e..6018ae8b2 100644 --- a/doc/README.md +++ b/doc/README.md @@ -49,8 +49,8 @@ gridstack.js API - [minWidth(el, val)](#minwidthel-val) - [movable(el, val)](#movableel-val) - [move(el, x, y)](#moveel-x-y) - - [removeWidget(el[, removeDOM])](#removewidgetel-removedom) - - [removeAll([removeDOM])](#removeallremovedom) + - [removeWidget(el, removeDOM = true, triggerEvent = true)](#removewidgetel-removedom--true-triggerevent--true) + - [removeAll(removeDOM = true)](#removeallremovedom--true) - [resize(el, width, height)](#resizeel-width-height) - [resizable(el, val)](#resizableel-val) - [save(): GridStackWidget[]](#save-gridstackwidget) @@ -464,7 +464,7 @@ Parameters: - `el` - widget to move - `x`, `y` - new position. If value is `null` or `undefined` it will be ignored. -### removeWidget(el[, removeDOM]) +### removeWidget(el, removeDOM = true, triggerEvent = true) Removes widget from the grid. @@ -472,8 +472,9 @@ Parameters: - `el` - widget to remove. - `removeDOM` - if `false` node won't be removed from the DOM (Optional. Default `true`). +- `triggerEvent` if `false` (quiet mode) element will not be added to removed list and no 'removed' callbacks will be called (Default `true`). -### removeAll([removeDOM]) +### removeAll(removeDOM = true) Removes all widgets from the grid. diff --git a/src/gridstack.ts b/src/gridstack.ts index 764958d37..92e9765b2 100644 --- a/src/gridstack.ts +++ b/src/gridstack.ts @@ -895,6 +895,7 @@ export class GridStack { * Removes widget from the grid. * @param el widget or selector to modify * @param removeDOM if `false` DOM element won't be removed from the tree (Default? true). + * @param triggerEvent if `false` (quiet mode) element will not be added to removed list and no 'removed' callbacks will be called (Default? true). */ public removeWidget(els: GridStackElement, removeDOM = true, triggerEvent = true): GridStack { this.getElements(els).forEach(el => {