mirrors/unleashed-firmware
1
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-13 05:06:30 +04:00
Code Issues Activity

Documentation: new doc on Storage module and JS cleanup (#4161)

Browse Source 
- Add new doc on Storage module
- Improve formatting in the JS section for better readability
This commit is contained in:
knrn64
2025-03-26 17:29:26 +03:00
committed by GitHub
parent 02dedd60f3
commit 54adc38b3a
17 changed files with 898 additions and 298 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
documentation/js/js_gui__text_input.md
View File

@@ -11,33 +11,22 @@ let textInputView = require("gui/text_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
`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
## Example
For an example, refer to the `gui.js` example script.
# View props
## `minLength`
The shortest allowed text length.
## View props
Type: `number`
| Prop | Type | Description |
|-------------|--------|--------------------------------------------------|
| `minLength` | `number` | The shortest allowed text length. |
| `maxLength` | `number` | The longest allowed text length. <br> Default: `32` |
| `header` | `string` | A single line of text that appears above the keyboard. |
## `maxLength`
The longest allowed text length.
## View events
Type: `number`
Default: `32`
## `header`
A single line of text that appears above the keyboard.
Type: `string`
# View events
## `input`
Fires when the user selects the "Save" button and the text matches the length
constrained by `minLength` and `maxLength`.
Item type: `string`
| Item | Type | Description |
|-------------|--------|--------------------------------------------------|
| `input` | `string` | Fires when the user selects the "Save" button and the text matches the length constrained by `minLength` and `maxLength`. |