mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2025-12-12 20:49:49 +04:00
d34ff3310d
* Update and fix JS docs This could really use some automation, atleast for API reference There are TypeScript definitions and typedocs, we don't need to be monkeys copying and reformatting this to API reference by hand * Fix bugged character * JS: Fix Number.toString() with decimals * Fix * Forgot this one * docs: mention per-view child format * Added @portasynthinca3 to docs' codeowners * Updated CODEOWNERS --------- Co-authored-by: Anna Antonenko <portasynthinca3@gmail.com> Co-authored-by: hedger <hedger@nanode.su> Co-authored-by: hedger <hedger@users.noreply.github.com>
27 lines
950 B
Markdown
27 lines
950 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. |
|
|
| `font` | `string`| The font to display the text in (`"text"` or `"hex"`). |
|
|
| `focus` | `string`| The initial focus of the text box (`"start"` or `"end"`). |
|