@real-router/vue 0.8.0 → 0.10.0

package/src/composables/useRouteEnter.ts

@@ -0,0 +1,120 @@
+import { watch } from "vue";
+
+import { useRoute } from "./useRoute";
+
+import type { State } from "@real-router/core";
+
+export interface RouteEnterContext {
+  /** The route that was just activated. */
+  route: State;
+  /** The route that was active immediately before this navigation. */
+  previousRoute: State;
+}
+
+export type RouteEnterHandler = (context: RouteEnterContext) => void;
+
+export interface UseRouteEnterOptions {
+  /**
+   * Skip the handler when `route.name === previousRoute.name`
+   * (sort/filter/query-only navigations on the same route). Default:
+   * `true`. Symmetric with `useRouteExit`'s same-name option.
+   */
+  skipSameRoute?: boolean;
+}
+
+/**
+ * Fire `handler` once when the component mounts as a result of a
+ * navigation. Mirror of `useRouteExit` for the entry side.
+ *
+ * What this composable covers that an ad-hoc `watch` + `useRoute()`
+ * doesn't:
+ *
+ *   - **Skip-initial**: `watch` (with default `immediate: false`) plus the
+ *     explicit `route.transition.from` guard ensures the handler doesn't
+ *     fire on the very first state committed by `router.start()`.
+ *   - **Same-route skip** (default): handler is skipped when
+ *     `route.transition.from === route.name`. Sort/filter/query-only
+ *     navigations re-trigger the watcher, but they are not "entries" in
+ *     the animation / analytics sense. Opt out with
+ *     `skipSameRoute: false`.
+ *   - **Mount-time `route` / `previousRoute` snapshot**: handler receives
+ *     the values that were live at the moment of the new state, not the
+ *     latest ones (which may have moved on if the user navigated again
+ *     before the watcher drained).
+ *
+ * **Handler reactivity (Vue):** Vue composables run **once** during
+ * `setup()`; `handler` is captured in closure at the call site. To vary
+ * behavior over time, read refs/computeds inside the handler body.
+ *
+ * @example Direction-aware entry animation
+ * ```ts
+ * useRouteEnter(({ route }) => {
+ *   const direction = route.context.browser?.direction;
+ *   ref.value?.classList.add(
+ *     direction === "back" ? "slide-from-left" : "slide-from-right",
+ *   );
+ * });
+ * ```
+ *
+ * @example Analytics page-enter event (skip-initial built-in)
+ * ```ts
+ * useRouteEnter(({ route, previousRoute }) => {
+ *   analytics.track("page_enter", {
+ *     route: route.name,
+ *     from: previousRoute.name,
+ *   });
+ * });
+ * ```
+ *
+ * @example Reading rich transition metadata via `route.transition`
+ * ```ts
+ * useRouteEnter(({ route }) => {
+ *   if (route.transition.redirected) {
+ *     showToast(`Redirected from ${route.transition.from}`);
+ *   }
+ * });
+ * ```
+ */
+export function useRouteEnter(
+  handler: RouteEnterHandler,
+  options?: UseRouteEnterOptions,
+): void {
+  const { route, previousRoute } = useRoute();
+  const skipSameRoute = options?.skipSameRoute ?? true;
+  let lastHandledRoute: State | null = null;
+
+  watch(route, (newRoute) => {
+    const prev = previousRoute.value;
+
+    // Early-exit guards, top-down:
+    //
+    //   - **Skip-initial**: `!transition.from` catches the first commit
+    //     from `router.start()`. Vue's `watch` (default `immediate: false`)
+    //     does not fire on the initial state — kept for parity with
+    //     React/Preact and v8-ignored.
+    //   - **Skip-same-route**: query-only navigations have
+    //     `transition.from === route.name`. Opt-out via
+    //     `skipSameRoute: false`.
+    //   - **Defensive dedupe + missing `previousRoute`**: same `route`
+    //     ref between watcher activations is unexpected on Vue (driven
+    //     off ref identity); `!prev` is unreachable once
+    //     `transition.from` is set (core populates them together). Both
+    //     kept for parity with React; v8-ignored.
+    /* v8 ignore start */
+    if (!newRoute.transition.from) {
+      return;
+    }
+    /* v8 ignore stop */
+    if (skipSameRoute && newRoute.transition.from === newRoute.name) {
+      return;
+    }
+    /* v8 ignore start */
+    if (lastHandledRoute === newRoute || !prev) {
+      return;
+    }
+    /* v8 ignore stop */
+
+    lastHandledRoute = newRoute;
+    handler({ route: newRoute, previousRoute: prev });
+  });
+}

package/src/composables/useRouteExit.ts

@@ -0,0 +1,116 @@
+import { onScopeDispose } from "vue";
+
+import { useRouter } from "./useRouter";
+
+import type { State } from "@real-router/core";
+
+export interface RouteExitContext {
+  /** The route being left. */
+  route: State;
+  /** The route being navigated to. */
+  nextRoute: State;
+  /**
+   * AbortSignal that fires when this navigation is superseded by a later
+   * one (rapid clicks). Already filtered: when the handler runs,
+   * `signal.aborted` is guaranteed to be `false`. Use
+   * `signal.addEventListener("abort", cleanup, { once: true })` for
+   * cleanup that must run on cancellation.
+   */
+  signal: AbortSignal;
+}
+
+export interface UseRouteExitOptions {
+  /**
+   * Skip the handler when `route.name === nextRoute.name`
+   * (sort/filter/query-only navigations on the same route). Default:
+   * `true`.
+   */
+  skipSameRoute?: boolean;
+}
+
+export type RouteExitHandler = (
+  context: RouteExitContext,
+) => void | Promise<void>;
+
+/**
+ * Subscribe to the router's leave-window with the universal guards baked
+ * in. Wraps `router.subscribeLeave` so consumers don't repeat the same
+ * boilerplate every time:
+ *
+ *   - **Reentrant abort pre-check**: if `signal.aborted` is already `true`
+ *     when the handler would run (rapid navigation superseded a slower
+ *     one), the handler is skipped entirely.
+ *   - **Same-route skip**: by default, `route.name === nextRoute.name`
+ *     short-circuits the handler — query-only navigations skip the work.
+ *     Opt out with `skipSameRoute: false`.
+ *
+ * Cleanup is bound to the component's effect scope via `onScopeDispose`.
+ *
+ * If the handler returns a Promise, the router blocks on it. If the
+ * Promise resolves, navigation proceeds. If it rejects, the router emits
+ * `TRANSITION_CANCELLED`.
+ *
+ * **Handler reactivity (Vue):** Vue composables run **once** during
+ * `setup()`; `handler` is captured in closure at the call site. To vary
+ * behavior over time, read refs/computeds inside the handler body — do
+ * not rely on swapping the handler reference.
+ *
+ * @example Animation
+ * ```ts
+ * const ref = useTemplateRef<HTMLDivElement>("box");
+ *
+ * useRouteExit(async ({ signal }) => {
+ *   const el = ref.value;
+ *   if (!el) return;
+ *   el.classList.add("fade-out");
+ *   const cleanup = () => el.classList.remove("fade-out");
+ *   signal.addEventListener("abort", cleanup, { once: true });
+ *   try {
+ *     el.getBoundingClientRect();
+ *     await Promise.allSettled(el.getAnimations().map((a) => a.finished));
+ *   } finally {
+ *     cleanup();
+ *   }
+ * });
+ * ```
+ *
+ * @example Auto-save form draft
+ * ```ts
+ * useRouteExit(async ({ signal }) => {
+ *   if (formState.value.dirty) {
+ *     await api.saveDraft(formState.value, { signal });
+ *   }
+ * });
+ * ```
+ *
+ * @example Reading rich transition metadata via `nextRoute.transition`
+ * ```ts
+ * useRouteExit(({ route, nextRoute }) => {
+ *   if (nextRoute.transition.segments.deactivated.includes("products")) {
+ *     productCache.clear();
+ *   }
+ *   if (nextRoute.transition.redirected) return;
+ * });
+ * ```
+ */
+export function useRouteExit(
+  handler: RouteExitHandler,
+  options?: UseRouteExitOptions,
+): void {
+  const router = useRouter();
+  const skipSameRoute = options?.skipSameRoute ?? true;
+
+  const off = router.subscribeLeave(({ route, nextRoute, signal }) => {
+    if (skipSameRoute && route.name === nextRoute.name) {
+      return;
+    }
+
+    if (signal.aborted) {
+      return;
+    }
+
+    return handler({ route, nextRoute, signal });
+  });
+
+  onScopeDispose(off);
+}

package/src/index.ts

@@ -21,6 +21,10 @@ export { useRouteNode } from "./composables/useRouteNode";
 
 export { useRouterTransition } from "./composables/useRouterTransition";
 
+export { useRouteExit } from "./composables/useRouteExit";
+
+export { useRouteEnter } from "./composables/useRouteEnter";
+
 // Plugin
 export { createRouterPlugin } from "./createRouterPlugin";
 
@@ -42,6 +46,18 @@ export type {
   RouteViewNotFoundProps,
 } from "./components/RouteView";
 
+export type {
+  RouteExitContext,
+  RouteExitHandler,
+  UseRouteExitOptions,
+} from "./composables/useRouteExit";
+
+export type {
+  RouteEnterContext,
+  RouteEnterHandler,
+  UseRouteEnterOptions,
+} from "./composables/useRouteEnter";
+
 export type { Navigator } from "@real-router/core";
 
 export type { RouterTransitionSnapshot } from "@real-router/sources";