Skip to content

Commit 509fe24

Browse files
committed
removeWidget() doc update
1 parent 50a95c3 commit 509fe24

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

doc/CHANGES.md

+1
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Change log
4545
You can now have perfect square cells (default) [723](https://github.com/gridstack/gridstack.js/issues/723)
4646
- fix [1299](https://github.com/gridstack/gridstack.js/pull/1299) many columns round-off error
4747
- fix [1102](https://github.com/gridstack/gridstack.js/issues/1102) loose functionality when they are moved to a new grid
48+
- add optional params to `removeWidget()` to have quiet mode (no callbacks)
4849

4950
## 1.2.0 (2020-08-01)
5051

doc/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ gridstack.js API
4949
- [minWidth(el, val)](#minwidthel-val)
5050
- [movable(el, val)](#movableel-val)
5151
- [move(el, x, y)](#moveel-x-y)
52-
- [removeWidget(el[, removeDOM])](#removewidgetel-removedom)
53-
- [removeAll([removeDOM])](#removeallremovedom)
52+
- [removeWidget(el, removeDOM = true, triggerEvent = true)](#removewidgetel-removedom--true-triggerevent--true)
53+
- [removeAll(removeDOM = true)](#removeallremovedom--true)
5454
- [resize(el, width, height)](#resizeel-width-height)
5555
- [resizable(el, val)](#resizableel-val)
5656
- [save(): GridStackWidget[]](#save-gridstackwidget)
@@ -464,16 +464,17 @@ Parameters:
464464
- `el` - widget to move
465465
- `x`, `y` - new position. If value is `null` or `undefined` it will be ignored.
466466

467-
### removeWidget(el[, removeDOM])
467+
### removeWidget(el, removeDOM = true, triggerEvent = true)
468468

469469
Removes widget from the grid.
470470

471471
Parameters:
472472

473473
- `el` - widget to remove.
474474
- `removeDOM` - if `false` node won't be removed from the DOM (Optional. Default `true`).
475+
- `triggerEvent` if `false` (quiet mode) element will not be added to removed list and no 'removed' callbacks will be called (Default `true`).
475476

476-
### removeAll([removeDOM])
477+
### removeAll(removeDOM = true)
477478

478479
Removes all widgets from the grid.
479480

src/gridstack.ts

+1
Original file line numberDiff line numberDiff line change
@@ -895,6 +895,7 @@ export class GridStack {
895895
* Removes widget from the grid.
896896
* @param el widget or selector to modify
897897
* @param removeDOM if `false` DOM element won't be removed from the tree (Default? true).
898+
* @param triggerEvent if `false` (quiet mode) element will not be added to removed list and no 'removed' callbacks will be called (Default? true).
898899
*/
899900
public removeWidget(els: GridStackElement, removeDOM = true, triggerEvent = true): GridStack {
900901
this.getElements(els).forEach(el => {

0 commit comments

Comments
 (0)