mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-11-27 04:25:15 +00:00
Code Issues Releases Wiki Activity

Feat: destroy() method for widgets to do custom cleanup (#6699)

Browse Source 
* feat: inform child widget to do some custom cleanup

* fix: type

* refactor: restore old removeChildDomNodes

* refactor: make destroy() a separate method

* refactor: make destroy call removeChildDomNodes

* refactor: call destroy instead of removeChildDomNodes in each core widgets

* fix: refreshSelf does not mean destroy

* refactor: use old var insteadof const

* docs: about subclass
This commit is contained in:
lin onetwo
2023-05-06 19:19:11 +08:00
committed by GitHub
parent 2b95daf59b
commit 474b73bdbe
8 changed files with 37 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
core/modules/widgets/widget.js
View File

@@ -688,7 +688,7 @@ Rebuild a previously rendered widget
*/
Widget.prototype.refreshSelf = function() {
var nextSibling = this.findNextSiblingDomNode();
this.removeChildDomNodes();
this.removeChildDomNodes({ recursive: true });
this.render(this.parentDomNode,nextSibling);
};
@@ -753,19 +753,42 @@ Widget.prototype.findFirstDomNode = function() {
/*
Remove any DOM nodes created by this widget or its children
*/
Widget.prototype.removeChildDomNodes = function() {
// If this widget has directly created DOM nodes, delete them and exit. This assumes that any child widgets are contained within the created DOM nodes, which would normally be the case
Widget.prototype.removeChildDomNodes = function(options) {
var recursive = options && options.recursive;
/**
* If this widget has directly created DOM nodes, delete them and exit.
* This assumes that any child widgets are contained within the created DOM nodes, which would normally be the case
*/
if(this.domNodes.length > 0) {
$tw.utils.each(this.domNodes,function(domNode) {
domNode.parentNode.removeChild(domNode);
});
this.domNodes = [];
} else {
return true;
} else if(recursive) {
// Otherwise, ask the child widgets to delete their DOM nodes
$tw.utils.each(this.children,function(childWidget) {
childWidget.removeChildDomNodes();
childWidget.removeChildDomNodes(options);
});
}
return false
};
/*
Inform widget subclass that extends this widget and children widgets of this widget. Let them know this widget tree is about to destroy, and dom nodes are being unmounted from the document.
*/
Widget.prototype.destroy = function(options) {
// removeDom by default
var removeDom = (options && options.removeDom) || true;
if (removeDom) {
// prepare options for children, if we have removed the dom, child don't need to remove their dom
removeDom = !this.removeChildDomNodes();
}
// nothing need to do, as dom is already removed in the removeChildDomNodes
// we just need to inform the children
$tw.utils.each(this.children,function(childWidget) {
childWidget.destroy({ removeDom: removeDom });
});
};
/*