Mirror/Momentum-Firmware
1
0
Fork 0
mirror of https://github.com/Next-Flip/Momentum-Firmware.git synced 2026-04-27 03:49:58 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'ofw/dev' into mntm-dev --nobuild

Browse Source
This commit is contained in:
Willy-JL
2025-04-01 01:40:05 +00:00
parent 12f65f17aa 0eb3fc33dd
commit a0619c01d7
139 changed files with 1534 additions and 854 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
documentation/js/js_gui__text_input.md
View File

@@ -11,43 +11,25 @@ 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. |
| `defaultText` | `string` | Text to show by default. |
| `defaultTextClear` | `boolean` | Whether to clear the default text on next character typed. |
| `illegalSymbols` | `boolean` | Whether to show illegal filename symbols. <br> Available with JS feature `gui-textinput-illegalsymbols` |
## `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`
## `defaultText`
Text to show in keyboard by default
Type: `string`
## `defaultTextClear`
Whether to clear the default text when user inuts another key
Type: `boolean`
# 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`. |