mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2025-12-12 12:42:30 +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>
33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
# Byte input GUI view {#js_gui__byte_input}
|
|
|
|
Displays a hexadecimal keyboard.
|
|
|
|
<img src="byte_input.png" width="200" alt="Sample screenshot of the view" />
|
|
|
|
```js
|
|
let eventLoop = require("event_loop");
|
|
let gui = require("gui");
|
|
let byteInputView = require("gui/byte_input");
|
|
```
|
|
|
|
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 |
|
|
|-------------|--------|--------------------------------------------------|
|
|
| `length` | `number` | The length in bytes of the buffer to modify. |
|
|
| `header` | `string` | A single line of text that appears above the keyboard. |
|
|
| `defaultData` | `string` | Data to show by default. |
|
|
|
|
## View events
|
|
|
|
| Item | Type | Description |
|
|
|-------------|--------|--------------------------------------------------|
|
|
| `input` | `ArrayBuffer` | Fires when the user selects the "Save" button. |
|