mirror of
https://github.com/flipperdevices/flipperzero-firmware.git
synced 2025-12-12 12:51:22 +04:00
Docs: Fix doxygen references from PR 4168 (#4169)
* Docs: Fix doxygen references from PR 4168 * Update JS GUI adapter table --------- Co-authored-by: hedger <hedger@users.noreply.github.com>
This commit is contained in:
@@ -17,6 +17,7 @@ Flipper Zero's built-in JavaScript engine enables you to run lightweight scripts
|
|||||||
|
|
||||||
- @subpage js_badusb — This module allows you to emulate a standard USB keyboard
|
- @subpage js_badusb — This module allows you to emulate a standard USB keyboard
|
||||||
- @subpage js_event_loop — The module for easy event-based developing
|
- @subpage js_event_loop — The module for easy event-based developing
|
||||||
|
- @subpage js_flipper — This module allows to query device information
|
||||||
- @subpage js_gpio — This module allows you to control GPIO pins
|
- @subpage js_gpio — This module allows you to control GPIO pins
|
||||||
- @subpage js_gui — This module allows you to use GUI (graphical user interface)
|
- @subpage js_gui — This module allows you to use GUI (graphical user interface)
|
||||||
- @subpage js_math — This module contains mathematical methods and constants
|
- @subpage js_math — This module contains mathematical methods and constants
|
||||||
|
|||||||
@@ -10,12 +10,15 @@ let gui = require("gui");
|
|||||||
|
|
||||||
GUI module has several submodules:
|
GUI module has several submodules:
|
||||||
|
|
||||||
- @subpage js_gui__submenu — Displays a scrollable list of clickable textual entries
|
- @subpage js_gui__byte_input — Keyboard-like hex input
|
||||||
- @subpage js_gui__loading — Displays an animated hourglass icon
|
|
||||||
- @subpage js_gui__empty_screen — Just empty screen
|
|
||||||
- @subpage js_gui__text_input — Keyboard-like text input
|
|
||||||
- @subpage js_gui__text_box — Simple multiline text box
|
|
||||||
- @subpage js_gui__dialog — Dialog with up to 3 options
|
- @subpage js_gui__dialog — Dialog with up to 3 options
|
||||||
|
- @subpage js_gui__empty_screen — Just empty screen
|
||||||
|
- @subpage js_gui__file_picker — Displays a file selection prompt
|
||||||
|
- @subpage js_gui__icon — Retrieves and loads icons for use in GUI
|
||||||
|
- @subpage js_gui__loading — Displays an animated hourglass icon
|
||||||
|
- @subpage js_gui__submenu — Displays a scrollable list of clickable textual entries
|
||||||
|
- @subpage js_gui__text_box — Simple multiline text box
|
||||||
|
- @subpage js_gui__text_input — Keyboard-like text input
|
||||||
- @subpage js_gui__widget — Displays a combination of custom elements on one screen
|
- @subpage js_gui__widget — Displays a combination of custom elements on one screen
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -38,23 +41,23 @@ always access the canvas through a viewport.
|
|||||||
In Flipper's terminology, a "View" is a fullscreen design element that assumes
|
In Flipper's terminology, a "View" is a fullscreen design element that assumes
|
||||||
control over the entire viewport and all input events. Different types of views
|
control over the entire viewport and all input events. Different types of views
|
||||||
are available (not all of which are unfortunately currently implemented in JS):
|
are available (not all of which are unfortunately currently implemented in JS):
|
||||||
| View | Has JS adapter? |
|
| View | Has JS adapter? |
|
||||||
|----------------------|------------------|
|
|----------------------|-----------------------|
|
||||||
| `button_menu` | ❌ |
|
| `button_menu` | ❌ |
|
||||||
| `button_panel` | ❌ |
|
| `button_panel` | ❌ |
|
||||||
| `byte_input` | ❌ |
|
| `byte_input` | ✅ |
|
||||||
| `dialog_ex` | ✅ (as `dialog`) |
|
| `dialog_ex` | ✅ (as `dialog`) |
|
||||||
| `empty_screen` | ✅ |
|
| `empty_screen` | ✅ |
|
||||||
| `file_browser` | ❌ |
|
| `file_browser` | ✅ (as `file_picker`) |
|
||||||
| `loading` | ✅ |
|
| `loading` | ✅ |
|
||||||
| `menu` | ❌ |
|
| `menu` | ❌ |
|
||||||
| `number_input` | ❌ |
|
| `number_input` | ❌ |
|
||||||
| `popup` | ❌ |
|
| `popup` | ❌ |
|
||||||
| `submenu` | ✅ |
|
| `submenu` | ✅ |
|
||||||
| `text_box` | ✅ |
|
| `text_box` | ✅ |
|
||||||
| `text_input` | ✅ |
|
| `text_input` | ✅ |
|
||||||
| `variable_item_list` | ❌ |
|
| `variable_item_list` | ❌ |
|
||||||
| `widget` | ❌ |
|
| `widget` | ✅ |
|
||||||
|
|
||||||
In JS, each view has its own set of properties (or just "props"). The programmer
|
In JS, each view has its own set of properties (or just "props"). The programmer
|
||||||
can manipulate these properties in two ways:
|
can manipulate these properties in two ways:
|
||||||
|
|||||||
Reference in New Issue
Block a user