feat(RouteNavigate): nav(-1) goBack history support (#6324)

QwikDev · May 16, 2024 · d79b934 · d79b934
1 parent 3b862ef
commit d79b934
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 4 deletions.
diff --git a/packages/docs/src/routes/api/qwik-city/api.json b/packages/docs/src/routes/api/qwik-city/api.json
@@ -642,7 +642,7 @@
         }
       ],
       "kind": "TypeAlias",
-      "content": "```typescript\nexport type RouteNavigate = QRL<(path?: string, options?: {\n    type?: Exclude<NavigationType, 'initial'>;\n    forceReload?: boolean;\n    replaceState?: boolean;\n    scroll?: boolean;\n} | boolean) => Promise<void>>;\n```\n**References:** [NavigationType](#navigationtype)",
+      "content": "```typescript\nexport type RouteNavigate = QRL<(path?: string | number, options?: {\n    type?: Exclude<NavigationType, 'initial'>;\n    forceReload?: boolean;\n    replaceState?: boolean;\n    scroll?: boolean;\n} | boolean) => Promise<void>>;\n```\n**References:** [NavigationType](#navigationtype)",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
       "mdFile": "qwik-city.routenavigate.md"
     },

diff --git a/packages/docs/src/routes/api/qwik-city/index.md b/packages/docs/src/routes/api/qwik-city/index.md
@@ -2100,7 +2100,7 @@ URL
 ```typescript
 export type RouteNavigate = QRL<
   (
-    path?: string,
+    path?: string | number,
     options?:
       | {
           type?: Exclude<NavigationType, "initial">;

diff --git a/packages/qwik-city/runtime/src/api.md b/packages/qwik-city/runtime/src/api.md
@@ -402,7 +402,7 @@ export interface RouteLocation {
 }
 
 // @public (undocumented)
-export type RouteNavigate = QRL<(path?: string, options?: {
+export type RouteNavigate = QRL<(path?: string | number, options?: {
     type?: Exclude<NavigationType, 'initial'>;
     forceReload?: boolean;
     replaceState?: boolean;

diff --git a/packages/qwik-city/runtime/src/qwik-city-component.tsx b/packages/qwik-city/runtime/src/qwik-city-component.tsx
@@ -152,6 +152,12 @@ export const QwikCityProvider = component$<QwikCityProps>((props) => {
       replaceState = false,
       scroll = true,
     } = typeof opt === 'object' ? opt : { forceReload: opt };
+    if (typeof path === 'number') {
+      if (isBrowser) {
+        history.go(path);
+      }
+      return;
+    }
     const lastDest = routeInternal.value.dest;
     const dest = path === undefined ? lastDest : toUrl(path, routeLocation.url);
 

diff --git a/packages/qwik-city/runtime/src/types.ts b/packages/qwik-city/runtime/src/types.ts
@@ -90,7 +90,7 @@ export type ScrollState = {
 /** @public */
 export type RouteNavigate = QRL<
   (
-    path?: string,
+    path?: string | number,
     options?:
       | {
           type?: Exclude<NavigationType, 'initial'>;