Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New js modules documentation added #3736

Merged
merged 4 commits into from
Jun 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions documentation/doxygen/js.dox
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ JS modules use the Flipper app plugin system. Each module is compiled into a .fa

- @subpage js_badusb - BadUSB module
- @subpage js_serial - Serial module
- @subpage js_math - Math module
- @subpage js_dialog - Dialog module
- @subpage js_submenu - Submenu module
- @subpage js_textbox - Textbox module
- @subpage js_notification - Notifications module

*/
6 changes: 3 additions & 3 deletions documentation/js/js_badusb.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ badusb.println("Hello, world!"); // print "Hello, world!" and press "ENTER"

| Name |
| ------------- |
| CTRL |
| SHIFT |
| CTRL |
| SHIFT |
| ALT |
| GUI |
| GUI |

## Special keys

Expand Down
6 changes: 3 additions & 3 deletions documentation/js/js_dialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Show a simple message dialog with header, text and "OK" button.
- Dialog header text
- Dialog text

### Retuns
### Returns
true if central button was pressed, false if the dialog was closed by back key press

### Examples:
Expand All @@ -25,14 +25,14 @@ dialog.message("Dialog demo", "Press OK to start");
More complex dialog with configurable buttons

### Parameters
Configuration object with the following fileds:
Configuration object with the following fields:
- header: Dialog header text
- text: Dialog text
- button_left: (optional) left button name
- button_right: (optional) right button name
- button_center: (optional) central button name

### Retuns
### Returns
Name of pressed button or empty string if the dialog was closed by back key press

### Examples:
Expand Down
Loading