Widget Steps v7 - nodeGame/nodegame GitHub Wiki

Widgets-steps are a particular type of steps where a widget is loaded in the frame waiting for some input from the user.

When node.done() is called, the widget checks if any action from the user is still required; if so, the game won't step forward. If everything is in order, the return value from the widget's getValues() is passed as input parameter to node.done() and sent to the server.

Usecase

To create a widget-step, just extend an existing step with a widget property containing the name of the desired widget, e.g. MoodGauge:

stager.extendStep("mood", { widget: "MoodGauge" });

Below is an example with all the available options.

stager.extendStep("mood", {

    widget: {
        // Name of the widget to load.
        name: 'MoodGauge',

        // Optional custom id.
        id: 'my_widget_id', // Default: 'ng_step_widget_' + name

        // Optional id of the root element for the widget.
        root: 'append-to-this-root', // Default: an element with id
                                     // 'widget-container', or the
                                     // document.body element of the IFRAME, or
                                     // the document.body element of the page.

        // Do not append the widget,
        // just make it available in node.widgets.instances
        append: false, // Default: TRUE.

        // Do not check if values are correct (as returned by `getValues()`).
        checkValues: false, // Default: TRUE.

        // Widget-specific options.
        choices: [ 1, 2, 3 ],
        emotions: [ 'Upset', 'Active' ]

        // Before v7.1.0, widget-specific options needed to specified inside
        // an options object. This is no longer necessary, but still allowed.
        // options: {
        //     choices: [ 1, 2, 3 ],
        //     emotions: [ 'Upset', 'Active' ]
        // }
    },

    // Optional step properties.

    // Frame.
    frame: 'my/custom/frame.html', // Default: a blank page.

    // Callback.
    cb: function() { ... },        // Executed after the widget
                                   // is appended.

    // Done.
    done: function(values) { ... } // Executed if there are no errors,
                                   // it receives the return value of
                                   // the getValues() method as input parameter.
});

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** ⚠️