aboutsummaryrefslogtreecommitdiffstats
path: root/desktop/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/README.md')
-rw-r--r--desktop/README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/desktop/README.md b/desktop/README.md
index ed30620..42c2efb 100644
--- a/desktop/README.md
+++ b/desktop/README.md
@@ -39,11 +39,16 @@ gear tile opens it, and so does IPC:
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 search above the list matches each page's label, its module's
+`keywords`, and the rows inside it: every git value, every autostart line.
+A row hit opens its page scrolled to that row, flashed in the accent. Enter
+opens the first result, Escape clears.
+
+Pages load only when opened, so a module keeps its own copy of its rows,
+`searchItems` (`[{text, key}]`), and the window calls its `refresh()` on
+every open. `key` is the `objectName` of the row in the page; `Page.reveal()`
+looks for it, waiting up to 3s for the page's data to arrive, scrolls to it
+and flashes it, so a page needs no highlight code of its own.
## The modules