1
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-13 13:09:49 +04:00
Files
unleashed-firmware/documentation/js/js_gui__text_box.md
knrn64 54adc38b3a Documentation: new doc on Storage module and JS cleanup (#4161)
- Add new doc on Storage module
- Improve formatting in the JS section for better readability
2025-03-26 18:29:26 +04:00

25 lines
761 B
Markdown

# Text box GUI view {#js_gui__text_box}
Displays a scrollable read-only text field.
<img src="text_box.png" width="200" alt="Sample screenshot of the view" />
```js
let eventLoop = require("event_loop");
let gui = require("gui");
let textBoxView = require("gui/text_box");
```
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
| Prop | Type | Description |
|----------|---------|------------------------------------|
| `text` | `string`| Text to show in the text box. |