1
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-12 04:34:43 +04:00
Files
unleashed-firmware/documentation/js/js_gui__dialog.md
Ruslan Nadyrshin 02dedd60f3 Add guides on Getting Started with JS (#4150)
- Get started section added to the JS docs
- Small fixes in the JS modules docs
2025-03-19 02:08:23 +10:00

1.2 KiB

Dialog GUI view

Displays a dialog with up to three options.

Sample screenshot of the view
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

header

Text that appears in bold at the top of the screen.

Type: string

text

Text that appears in the middle of the screen.

Type: string

left

Text for the left button. If unset, the left button does not show up.

Type: string

center

Text for the center button. If unset, the center button does not show up.

Type: string

right

Text for the right button. If unset, the right button does not show up.

Type: string

View events

input

Fires 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.

Item type: string