Widgets Operations v7 - nodeGame/nodegame GitHub Wiki

Loading Widgets

Widgets are created and managed with the object node.widgets.

// Creating and appending a widget to the page.
var root = W.getElementById('myRoot');
var timer = node.widgets.append('VisualTimer', root);
// Alternative you can directly pass the id of the element.
var timer = node.widgets.append('VisualTimer', 'myRoot');

// Without generating HTML.
var widget = node.widgets.get('MoodGauge');

// Integrating a custom widget.
var options = {};
var customWidget = new MyCustomWidget(options);
node.widgets.append(customWidget, root);

Widget Anatomy

After a widget has been appended, the following HTML div elements are created as part of the widget interface:

  • panelDiv: the outer div containing all other elements below.
    • headingDiv: the div containing the title of the widget.
    • bodyDiv: the div containing the main content of the widget.
    • footerDiv: the div containing the footer of the widget (hidden by default).

References to Existing Widgets

After a new widget is created a reference is added inside the array node.widgets.instances.

node.widgets.instances[0]; // VisualTimer.
node.widgets.instances[1]; // MoodGauge.
node.widgets.instances[2]; // CustomWidget.

A reference to the last appended widget is stored in under lastAppended:

node.widgets.lastAppended; // CustomWidget.

Destroying Widgets

To destroy a widget and removing it from the DOM, just invoke the destroy method on the widget itself.

node.widgets.lastAppended.destroy();

// To destroy all widgets:
node.widgets.destroyAll();

Garbage Collection

Previously appended widgets that are no longer found on the page are destroyed upon entering a new step.

Next

Go back to the wiki Home.

License

Copyright (C) 2021 Stefano Balietti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

⚠️ **GitHub.com Fallback** ⚠️