Back to Momentum Firmware

Dialog GUI view {#js_gui__dialog}

documentation/js/js_gui__dialog.md

latest1.6 KB
Original Source

Dialog GUI view {#js_gui__dialog}

Displays a dialog with up to three options.

js
let eventLoop = require("event_loop");
let gui = require("gui");
let dialogView = require("gui/dialog");

This module depends on the gui module, which in turn depends on the event_loop module, so they must be imported in this order. It is also recommended to conceptualize these modules first before using this one.

Example

For an example, refer to the gui.js example script.

View props

PropTypeDescription
headerstringText that appears in bold at the top of the screen.
textstringText that appears in the middle of the screen.
leftstringText for the left button. If unset, the left button does not show up.
centerstringText for the center button. If unset, the center button does not show up.
rightstringText for the right button. If unset, the right button does not show up.

View events

ItemTypeDescription
inputstringFires when the user presses on either of the three possible buttons. The item contains one of the strings "left", "center", or "right" depending on the button.