mirror of
https://github.com/Next-Flip/Momentum-Firmware.git
synced 2026-04-24 03:29:57 -07:00
54 lines
1.1 KiB
Markdown
54 lines
1.1 KiB
Markdown
# Text input GUI view {#js_gui__text_input}
|
|
|
|
Displays a keyboard.
|
|
|
|
<img src="text_input.png" width="200" alt="Sample screenshot of the view" />
|
|
|
|
```js
|
|
let eventLoop = require("event_loop");
|
|
let gui = require("gui");
|
|
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
|
|
recommended to conceptualize these modules first before using this one.
|
|
|
|
# Example
|
|
For an example, refer to the `gui.js` example script.
|
|
|
|
# View props
|
|
## `minLength`
|
|
The shortest allowed text length.
|
|
|
|
Type: `number`
|
|
|
|
## `maxLength`
|
|
The longest allowed text length.
|
|
|
|
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`
|