docs: goTo, reloadInPlace and dash:refreshed for page scripts

Check: docs/Dashboard.md, Live updates: the page-scripts paragraph names
goTo(url) and reloadInPlace() and says when dash:refreshed is used.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Aaron Kimbrell
2026-09-29 02:10:04 -05:00
parent 2629b41e6c
commit cde8ea4979

View File

@@ -373,9 +373,10 @@ them load normally. Leaving a page with unsaved changes (Settings, Vanity) asks
For page scripts (`static/js/nav.js`): listeners a page adds to `document` or `window`, its `setInterval` timers, its For page scripts (`static/js/nav.js`): listeners a page adds to `document` or `window`, its `setInterval` timers, its
`Live` watchers and its DataTables are removed when another page is swapped in; its scripts run again when it's opened `Live` watchers and its DataTables are removed when another page is swapped in; its scripts run again when it's opened
again, and `DOMContentLoaded`/`load` handlers they add run once they have all run. Elements a page appends to `<body>` again, and `DOMContentLoaded`/`load` handlers they add run once they have all run. Elements a page appends to `<body>`
are removed unless marked `data-nav-keep`. `Nav.go(url)` opens a page, `Nav.refresh()` updates the current one in place. are removed unless marked `data-nav-keep`. `Nav.go(url)` opens a page, `Nav.refresh()` updates the current one in place;
`document` gets `dash:page` after a page is swapped in, `dash:leave` before, and `dash:refreshed` after an in-place `goTo(url)` and `reloadInPlace()` (`common.js`) do the same, or load normally without `nav.js`. `document` gets
update. A page that must always load on its own adds `data-nav="reload"` to any element; a link with `data-nav="off"` `dash:page` after a page is swapped in, `dash:leave` before, and `dash:refreshed` after an in-place update (pages that
format server values in the browser, like times, do it again then). A page that must always load on its own adds `data-nav="reload"` to any element; a link with `data-nav="off"`
always loads normally. always loads normally.
View choices you make on the pages (show staff, filters, the 3D viewer's switches, ...) are saved to your account, so View choices you make on the pages (show staff, filters, the 3D viewer's switches, ...) are saved to your account, so