FOSS
/
BangleApps
mirror of https://github.com/espruino/BangleApps
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

settings: note push/pop/restoreMenu in README

pull/3630/head
Rob Pilling 2024-11-19 22:05:30 +00:00
parent 24d92f4f03
commit 308956b17b
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
apps/setting/README.md
View File

@ -67,3 +67,13 @@ The exact effects depend on the app. In general the watch will not wake up by i
* **Reset Settings** Reset the settings (as set in this app) to defaults. Does not reset settings for other apps.
* **Factory Reset** (not available on Bangle.js 1) - wipe **everything** and return to a factory state
* **Turn Off** Turn Bangle.js off
# Development
The settings code uses `push/pop/restoreMenu` to navigate different levels of menus. These functions are used as follows:
- `pushMenu`: enter a new level of menu, one deeper than the current (e.g. a submenu)
- `popMenu`: return to the previous menu level, one more shallow than the current (e.g. returning from a submenu)
- `restoreMenu`: redraw the current menu (e.g. after an alert)
These functions will keep track of outer menu's scroll positions, to avoid the user being returned to the very first entry as they navigate.