@leavepulse/ui 0.76.0 → 0.76.1

package/README.md

@@ -113,7 +113,10 @@ provideOverlayHistory(true, { router })
   `update:open` true while the overlay is still mounted.
 - `history` on a single overlay wins over the app-wide mode: `false` keeps an
   overlay out of history, for one the app already opens from its route query
-  (it would otherwise take two entries for one dialog).
+  (it would otherwise take two entries for one dialog). An overlay the app
+  writes into the query with `router.replace` needs nothing: when it closes,
+  the address the app left is kept, and the overlay does not open again from
+  the entry under it.
 - A real navigation (a link, `router.push` to another path) closes the open
   overlays, and the entries they leave under the new page are skipped, so Back
   from it lands on the page in one press. A push that keeps the path (a query

package/dist/composables/overlayHistory.js

@@ -11,6 +11,7 @@ const fresh = {
   closed: /* @__PURE__ */ new Map(),
   dead: /* @__PURE__ */ new Map(),
   silent: 0,
+  keep: null,
   waiting: [],
   href: "",
   serial: 0,
@@ -75,6 +76,9 @@ function handlePop(event) {
   s.href = location.href;
   if (s.silent > 0) {
     s.silent--;
+    const keep = s.silent === 0 ? s.keep : null;
+    if (s.silent === 0) s.keep = null;
+    if (keep && keep.href !== location.href) restore(keep, event);
     if (before === location.href) event.stopImmediatePropagation();
     flushWaiting();
     return;
@@ -121,6 +125,14 @@ function handlePop(event) {
     leavePage();
   }
 }
+function restore(keep, event) {
+  const mark = markOf(event.state);
+  const base = keep.state && typeof keep.state === "object" ? { ...keep.state } : {};
+  delete base[KEY];
+  own(() => history.replaceState(mark ? { ...base, [KEY]: mark } : base, "", keep.href));
+  s.href = location.href;
+  event.stopImmediatePropagation();
+}
 const DEAD_LIMIT = 200;
 function bury(item) {
   s.dead.set(item.token, item);
@@ -217,6 +229,7 @@ function dropEntry(entry) {
   const positioned = onTop();
   const removed = s.live.splice(at);
   if (positioned) {
+    s.keep = { href: location.href, state: history.state };
     silentGo(-removed.length);
     return;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leavepulse/ui",
-  "version": "0.76.0",
+  "version": "0.76.1",
   "type": "module",
   "description": "LeavePulse token-driven Vue component kit.",
   "repository": {

package/src/composables/overlayHistory.ts

@@ -31,6 +31,11 @@
  *    entries keep working once Back returns past it.
  *  - Someone else's `replaceState` on a kit entry keeps the kit's key, so a
  *    router saving its scroll position does not orphan the entry.
+ *  - An app that keeps an overlay in its query through `replace` rewrites the
+ *    address of the kit's entry when the overlay closes, and the entry under it
+ *    still holds the old one. Taking the entry out lands there, so the address
+ *    the app left is put back on it and the step never reaches the router:
+ *    handed over, it would navigate to the old query and open the overlay again.
  */
 
 const KEY = "__lpOverlay"
@@ -79,6 +84,8 @@ interface EngineState {
   dead: Map<string, Tracked>
   /** Pops the kit started itself and swallows on arrival. */
   silent: number
+  /** What the page showed before the kit took entries out, to be kept where the step lands. */
+  keep: { href: string; state: unknown } | null
   waiting: Array<() => void>
   href: string
   serial: number
@@ -98,6 +105,7 @@ const fresh: EngineState = {
   closed: new Map(),
   dead: new Map(),
   silent: 0,
+  keep: null,
   waiting: [],
   href: "",
   serial: 0,
@@ -174,6 +182,9 @@ function handlePop(event: PopStateEvent) {
   s.href = location.href
   if (s.silent > 0) {
     s.silent--
+    const keep = s.silent === 0 ? s.keep : null
+    if (s.silent === 0) s.keep = null
+    if (keep && keep.href !== location.href) restore(keep, event)
     if (before === location.href) event.stopImmediatePropagation()
     flushWaiting()
     return
@@ -229,6 +240,16 @@ function handlePop(event: PopStateEvent) {
   }
 }
 
+/* The address the app left on the entry the kit took out, put back where the step landed. */
+function restore(keep: { href: string; state: unknown }, event: PopStateEvent) {
+  const mark = markOf(event.state)
+  const base = keep.state && typeof keep.state === "object" ? { ...(keep.state as Record<string, unknown>) } : {}
+  delete base[KEY]
+  own(() => history.replaceState(mark ? { ...base, [KEY]: mark } : base, "", keep.href))
+  s.href = location.href
+  event.stopImmediatePropagation()
+}
+
 /* Buried entries are kept by token; the oldest go first, history this deep is never walked back. */
 const DEAD_LIMIT = 200
 function bury(item: Tracked) {
@@ -364,6 +385,7 @@ export function dropEntry(entry: HistoryEntry): void {
   const positioned = onTop()
   const removed = s.live.splice(at)
   if (positioned) {
+    s.keep = { href: location.href, state: history.state }
     silentGo(-removed.length)
     return
   }