tanstack-router-cache 0.1.7 → 0.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/dist/components/cached-outlet.cjs +12 -0
  2. package/dist/components/cached-outlet.js +12 -0
  3. package/dist/components/off-screen-in.cjs +130 -0
  4. package/dist/components/off-screen-in.js +130 -0
  5. package/dist/components/off-screen.cjs +8 -0
  6. package/dist/components/off-screen.js +8 -0
  7. package/dist/components/restore-cached-href.cjs +28 -0
  8. package/dist/components/restore-cached-href.js +28 -0
  9. package/dist/components/route-cache-manager.cjs +485 -0
  10. package/dist/components/route-cache-manager.js +485 -0
  11. package/dist/components/router-cache-outlet.cjs +9 -0
  12. package/dist/components/router-cache-outlet.js +9 -0
  13. package/dist/contexts/router-cache.cjs +237 -0
  14. package/dist/contexts/router-cache.d.ts +40 -0
  15. package/dist/contexts/router-cache.js +235 -0
  16. package/dist/dom/dismiss-transient-ui.cjs +230 -0
  17. package/dist/dom/dismiss-transient-ui.js +228 -0
  18. package/dist/hooks/use-event-listener.cjs +76 -0
  19. package/dist/hooks/use-event-listener.js +76 -0
  20. package/dist/hooks/use-route-cache-active.cjs +19 -0
  21. package/dist/hooks/use-route-cache-active.js +19 -0
  22. package/dist/hooks/use-route-cache-activity.cjs +12 -0
  23. package/dist/hooks/use-route-cache-activity.js +12 -0
  24. package/dist/hooks/use-route-cache-effect.cjs +38 -0
  25. package/dist/hooks/use-route-cache-effect.js +38 -0
  26. package/dist/hooks/use-route-cache-error-boundary.cjs +23 -0
  27. package/dist/hooks/use-route-cache-error-boundary.js +23 -0
  28. package/dist/hooks/use-route-cache-navigation.cjs +36 -0
  29. package/dist/hooks/use-route-cache-navigation.js +36 -0
  30. package/dist/hooks/use-router-cache-debug.cjs +85 -0
  31. package/dist/hooks/use-router-cache-debug.js +85 -0
  32. package/dist/hooks/use-router-cache.cjs +32 -0
  33. package/dist/hooks/use-router-cache.js +32 -0
  34. package/dist/hooks/use-update.cjs +8 -0
  35. package/dist/hooks/use-update.js +8 -0
  36. package/dist/index.cjs +18 -1402
  37. package/dist/index.d.ts +9 -1
  38. package/dist/index.js +10 -1395
  39. package/dist/pathname.cjs +8 -0
  40. package/dist/pathname.js +8 -0
  41. package/dist/route-cache-static-data.cjs +43 -0
  42. package/dist/route-cache-static-data.d.ts +45 -0
  43. package/dist/route-cache-static-data.js +41 -0
  44. package/dist/types.d.ts +28 -0
  45. package/docs/architecture.md +8 -5
  46. package/docs/cache-behavior.md +17 -0
  47. package/docs/components.md +1 -2
  48. package/docs/getting-started.md +38 -3
  49. package/docs/types.md +6 -0
  50. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import type { RouteCacheStaticOption } from "./types";
1
2
  export { RouterCacheOutlet } from "./components/router-cache-outlet";
2
3
  export type { CachedRouteData, CachedRoutes } from "./contexts/router-cache";
3
4
  export { RouterCacheProvider } from "./contexts/router-cache";
@@ -7,9 +8,16 @@ export { useRouteCacheEffect } from "./hooks/use-route-cache-effect";
7
8
  export { useRouteCacheErrorBoundary } from "./hooks/use-route-cache-error-boundary";
8
9
  export { useRouteCacheNavigation } from "./hooks/use-route-cache-navigation";
9
10
  export { useRouterCache } from "./hooks/use-router-cache";
11
+ export { defineRouteCache } from "./route-cache-static-data";
10
12
  export type * from "./types";
11
13
  declare module "@tanstack/react-router" {
12
14
  interface StaticDataRouteOption {
13
- routeCache?: boolean;
15
+ /**
16
+ * Enables retained route-view caching for this route.
17
+ *
18
+ * Use `true` for default behavior, or pass an options object for
19
+ * route-cache-specific settings such as `maxAge`.
20
+ */
21
+ routeCache?: RouteCacheStaticOption;
14
22
  }
15
23
  }