diff options
Diffstat (limited to 'desktop/README.md')
| -rw-r--r-- | desktop/README.md | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/desktop/README.md b/desktop/README.md index 187def6..ed30620 100644 --- a/desktop/README.md +++ b/desktop/README.md @@ -36,8 +36,14 @@ gear tile opens it, and so does IPC: qs -p ./desktop ipc call settings toggle `open` takes a page name; an unknown or empty one opens the landing page, -a tile per settings page. A page's back arrow and Escape return there; -Escape on the landing page closes the window. +a short About. A page's back arrow and Escape return there; Escape on the +landing page closes the window. + +The search above the list matches each page's label and its module's +`keywords`, the settings buried inside the page; an entry matched by a +keyword shows which one. Enter opens the first match, Escape clears. Pages +load only when opened, so their live contents (a git alias, an autostart +command) are not searched, only the keywords. ## The modules @@ -72,6 +78,8 @@ drawer needs to show it: - `page`: a `Component` for the full-height page behind the tile, or null. - `settings`: the page lives in the settings window, not the drawer, and the module has no tile. +- `keywords`: for a settings page, the words its search should find besides + the label. - `activate()`: what a tile with no page does when clicked. - `alwaysActive`: declares whether the module's service is meant to run while the drawer is closed. The drawer does not read it, the module implements its |