mirrors/flipperzero-firmware
1
Fork 0
mirror of https://github.com/flipperdevices/flipperzero-firmware.git synced 2025-12-12 20:59:50 +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

40
documentation/js/js_gui__dialog.md
View File

@@ -11,42 +11,24 @@ let dialogView = require("gui/dialog");
```
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
For an example, refer to the `gui.js` example script.
# View props
## `header`
Text that appears in bold at the top of the screen.
Type: `string`
## `text`
Text that appears in the middle of the screen.
Type: `string`
## `left`
Text for the left button. If unset, the left button does not show up.
Type: `string`
## `center`
Text for the center button. If unset, the center button does not show up.
Type: `string`
## `right`
Text for the right button. If unset, the right button does not show up.
Type: `string`
| **Prop** | **Type** | **Description** |
|------------|-----------|----------------------------------------------------------------|
| `header` | string | Text that appears in bold at the top of the screen. |
| `text` | string | Text that appears in the middle of the screen. |
| `left` | string | Text for the left button. If unset, the left button does not show up. |
| `center` | string | Text for the center button. If unset, the center button does not show up. |
| `right` | string | Text for the right button. If unset, the right button does not show up. |
# View events
## `input`
Fires when the user presses on either of the three possible buttons. The item
contains one of the strings `"left"`, `"center"` or `"right"` depending on the
button.
Item type: `string`
| Item | Type | Description |
|----------|--------|-----------------------------------------------------------------------------|
| `input` | `string`| Fires when the user presses on either of the three possible buttons. The item contains one of the strings `"left"`, `"center"`, or `"right"` depending on the button. |