From d5e8827f6888c2b49d1ab7640ff7ab5bff81e9ab Mon Sep 17 00:00:00 2001 From: Elliot Sutton Date: Fri, 28 Feb 2025 20:33:20 +0100 Subject: [PATCH] feat(docs): improve next useRouter docs --- apps/docs/content/docs/next/hooks/use-router.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/apps/docs/content/docs/next/hooks/use-router.mdx b/apps/docs/content/docs/next/hooks/use-router.mdx index b47a306..fdf1f3b 100644 --- a/apps/docs/content/docs/next/hooks/use-router.mdx +++ b/apps/docs/content/docs/next/hooks/use-router.mdx @@ -44,6 +44,7 @@ useRouter(options?: RouterProgressOptions): AppRouterProgressInstance; | startPosition | number | undefined | The start position of the progress bar. | | disableSameURL | boolean | `true` | Disable the progress bar when the URL is the same. | | basePath | string | undefined | The base path if you use a `basePath` in your app. | +| i18nPath | boolean | `false` | Takes into account the first parameter of the URL (e.g. /en) | | customRouter | () => AppRouterInstance | undefined | A custom router instance. | @@ -58,6 +59,7 @@ interface RouterProgressOptions { startPosition?: number; disableSameURL?: boolean; basePath?: string; + i18nPath?: boolean; customRouter?: () => AppRouterInstance; } ``` @@ -187,6 +189,7 @@ router.refresh({ startPosition: 0.3 }); | startPosition | number | undefined | The start position of the progress bar. | | disableSameURL | boolean | `true` | Disable the progress bar when the URL is the same. | | basePath | string | undefined | The base path if you use a `basePath` in your app. | +| i18nPath | boolean | `false` | Takes into account the first parameter of the URL (e.g. /en) | | _...customRouterOptions_ | any | undefined | Any custom options for the router, by default we use the next `NavigateOptions`. | @@ -201,6 +204,7 @@ interface RouterProgressOptions { startPosition?: number; disableSameURL?: boolean; basePath?: string; + i18nPath?: boolean; } ```