next-intl 2.17.5 → 2.18.0

package/dist/client/useRouter.d.ts

@@ -1,3 +1,6 @@
+type IntlNavigateOptions = {
+    locale?: string;
+};
 /**
  * Returns a wrapped instance of `useRouter` from `next/navigation` that
  * will automatically localize the `href` parameters it receives.
@@ -12,13 +15,17 @@
  *
  * // When the user is on `/en`, the router will navigate to `/en/about`
  * router.push('/about');
+ *
+ * // Optionally, you can switch the locale by passing the second argument
+ * router.push('/about', {locale: 'de'});
  * ```
  */
 export default function useRouter(): {
-    push(href: string, options?: import("next/dist/shared/lib/app-router-context").NavigateOptions | undefined): void;
-    replace(href: string, options?: import("next/dist/shared/lib/app-router-context").NavigateOptions | undefined): void;
-    prefetch(href: string, options?: import("next/dist/shared/lib/app-router-context").PrefetchOptions | undefined): void;
+    push(href: string, options?: (import("next/dist/shared/lib/app-router-context").NavigateOptions & IntlNavigateOptions) | undefined): void;
+    replace(href: string, options?: (import("next/dist/shared/lib/app-router-context").NavigateOptions & IntlNavigateOptions) | undefined): void;
+    prefetch(href: string, options?: (import("next/dist/shared/lib/app-router-context").PrefetchOptions & IntlNavigateOptions) | undefined): void;
     back(): void;
     forward(): void;
     refresh(): void;
 };
+export {};

package/dist/src/client/useRouter.d.ts

@@ -1,3 +1,6 @@
+type IntlNavigateOptions = {
+    locale?: string;
+};
 /**
  * Returns a wrapped instance of `useRouter` from `next/navigation` that
  * will automatically localize the `href` parameters it receives.
@@ -12,13 +15,17 @@
  *
  * // When the user is on `/en`, the router will navigate to `/en/about`
  * router.push('/about');
+ *
+ * // Optionally, you can switch the locale by passing the second argument
+ * router.push('/about', {locale: 'de'});
  * ```
  */
 export default function useRouter(): {
-    push(href: string, options?: import("next/dist/shared/lib/app-router-context").NavigateOptions | undefined): void;
-    replace(href: string, options?: import("next/dist/shared/lib/app-router-context").NavigateOptions | undefined): void;
-    prefetch(href: string, options?: import("next/dist/shared/lib/app-router-context").PrefetchOptions | undefined): void;
+    push(href: string, options?: (import("next/dist/shared/lib/app-router-context").NavigateOptions & IntlNavigateOptions) | undefined): void;
+    replace(href: string, options?: (import("next/dist/shared/lib/app-router-context").NavigateOptions & IntlNavigateOptions) | undefined): void;
+    prefetch(href: string, options?: (import("next/dist/shared/lib/app-router-context").PrefetchOptions & IntlNavigateOptions) | undefined): void;
     back(): void;
     forward(): void;
     refresh(): void;
 };
+export {};

package/dist/src/client/useRouter.js

@@ -16,25 +16,44 @@ import useClientLocale from './useClientLocale';
  *
  * // When the user is on `/en`, the router will navigate to `/en/about`
  * router.push('/about');
+ *
+ * // Optionally, you can switch the locale by passing the second argument
+ * router.push('/about', {locale: 'de'});
  * ```
  */
 export default function useRouter() {
     const router = useNextRouter();
     const locale = useClientLocale();
     return useMemo(() => {
-        function localize(href) {
-            return localizeHref(href, locale, locale, window.location.pathname);
+        function localize(href, nextLocale) {
+            return localizeHref(href, nextLocale || locale, locale, window.location.pathname);
         }
         return {
             ...router,
-            push(...[href, ...args]) {
-                return router.push(localize(href), ...args);
+            push(href, options) {
+                const { locale: nextLocale, ...rest } = options || {};
+                const args = [localize(href, nextLocale)];
+                if (Object.keys(rest).length > 0) {
+                    args.push(rest);
+                }
+                return router.push(...args);
             },
-            replace(...[href, ...args]) {
-                return router.replace(localize(href), ...args);
+            replace(href, options) {
+                const { locale: nextLocale, ...rest } = options || {};
+                const args = [localize(href, nextLocale)];
+                if (Object.keys(rest).length > 0) {
+                    args.push(rest);
+                }
+                return router.replace(...args);
             },
-            prefetch(...[href, ...args]) {
-                return router.prefetch(localize(href), ...args);
+            prefetch(href, options) {
+                const { locale: nextLocale, ...rest } = options || {};
+                const args = [localize(href, nextLocale)];
+                if (Object.keys(rest).length > 0) {
+                    // @ts-expect-error TypeScript thinks `rest` can be an empty object
+                    args.push(rest);
+                }
+                return router.prefetch(...args);
             }
         };
     }, [locale, router]);

package/dist/src/client/useRouter.js.map

@@ -1 +1 @@
-{"version":3,"file":"useRouter.js","sourceRoot":"","sources":["../../../src/client/useRouter.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,IAAI,aAAa,EAAC,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAC7C,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS;IAC/B,MAAM,MAAM,GAAG,aAAa,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;IAEjC,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,SAAS,QAAQ,CAAC,IAAY;YAC5B,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtE,CAAC;QAED,OAAO;YACL,GAAG,MAAM;YACT,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,CAAiC;gBACrD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;YAC9C,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,CAAoC;gBAC3D,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;YACjD,CAAC;YACD,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,CAAqC;gBAC7D,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;YAClD,CAAC;SACF,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACvB,CAAC"}
+{"version":3,"file":"useRouter.js","sourceRoot":"","sources":["../../../src/client/useRouter.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,IAAI,aAAa,EAAC,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAC7C,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAMhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS;IAC/B,MAAM,MAAM,GAAG,aAAa,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;IAEjC,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,SAAS,QAAQ,CAAC,IAAY,EAAE,UAAmB;YACjD,OAAO,YAAY,CACjB,IAAI,EACJ,UAAU,IAAI,MAAM,EACpB,MAAM,EACN,MAAM,CAAC,QAAQ,CAAC,QAAQ,CACzB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,GAAG,MAAM;YACT,IAAI,CACF,IAAY,EACZ,OAAiE;gBAEjE,MAAM,EAAC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAC,GAAG,OAAO,IAAI,EAAE,CAAC;gBACpD,MAAM,IAAI,GAGN,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;gBACjC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;oBAChC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACjB;gBACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YAC9B,CAAC;YAED,OAAO,CACL,IAAY,EACZ,OAAoE;gBAEpE,MAAM,EAAC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAC,GAAG,OAAO,IAAI,EAAE,CAAC;gBACpD,MAAM,IAAI,GAGN,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;gBACjC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;oBAChC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACjB;gBACD,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;YACjC,CAAC;YAED,QAAQ,CACN,IAAY,EACZ,OAAqE;gBAErE,MAAM,EAAC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAC,GAAG,OAAO,IAAI,EAAE,CAAC;gBACpD,MAAM,IAAI,GAGN,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;gBACjC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;oBAChC,mEAAmE;oBACnE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACjB;gBACD,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;YAClC,CAAC;SACF,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACvB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-intl",
-  "version": "2.17.5",
+  "version": "2.18.0",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.work>",
   "description": "A minimal, but complete solution for internationalization in Next.js apps.",
@@ -67,7 +67,7 @@
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.2.32",
     "negotiator": "^0.6.3",
-    "use-intl": "^2.17.5"
+    "use-intl": "^2.18.0"
   },
   "peerDependencies": {
     "next": "^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0",
@@ -87,7 +87,7 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "size-limit": "^8.2.6",
-    "typescript": "^4.9.5",
+    "typescript": "^5.0.0",
     "vitest": "^0.32.2"
   },
   "size-limit": [
@@ -103,5 +103,5 @@
   "engines": {
     "node": ">=10"
   },
-  "gitHead": "ff327ea485e3be4a5bf002a23a41292ec39dfd4d"
+  "gitHead": "023d23a7a71f5594d8a457c09ea988b56b248239"
 }

package/src/client/useRouter.tsx

@@ -3,6 +3,10 @@ import {useMemo} from 'react';
 import {localizeHref} from '../shared/utils';
 import useClientLocale from './useClientLocale';
 
+type IntlNavigateOptions = {
+  locale?: string;
+};
+
 /**
  * Returns a wrapped instance of `useRouter` from `next/navigation` that
  * will automatically localize the `href` parameters it receives.
@@ -17,6 +21,9 @@ import useClientLocale from './useClientLocale';
  *
  * // When the user is on `/en`, the router will navigate to `/en/about`
  * router.push('/about');
+ *
+ * // Optionally, you can switch the locale by passing the second argument
+ * router.push('/about', {locale: 'de'});
  * ```
  */
 export default function useRouter() {
@@ -24,20 +31,61 @@ export default function useRouter() {
   const locale = useClientLocale();
 
   return useMemo(() => {
-    function localize(href: string) {
-      return localizeHref(href, locale, locale, window.location.pathname);
+    function localize(href: string, nextLocale?: string) {
+      return localizeHref(
+        href,
+        nextLocale || locale,
+        locale,
+        window.location.pathname
+      );
     }
 
     return {
       ...router,
-      push(...[href, ...args]: Parameters<typeof router.push>) {
-        return router.push(localize(href), ...args);
+      push(
+        href: string,
+        options?: Parameters<typeof router.push>[1] & IntlNavigateOptions
+      ) {
+        const {locale: nextLocale, ...rest} = options || {};
+        const args: [
+          href: string,
+          options?: Parameters<typeof router.push>[1]
+        ] = [localize(href, nextLocale)];
+        if (Object.keys(rest).length > 0) {
+          args.push(rest);
+        }
+        return router.push(...args);
       },
-      replace(...[href, ...args]: Parameters<typeof router.replace>) {
-        return router.replace(localize(href), ...args);
+
+      replace(
+        href: string,
+        options?: Parameters<typeof router.replace>[1] & IntlNavigateOptions
+      ) {
+        const {locale: nextLocale, ...rest} = options || {};
+        const args: [
+          href: string,
+          options?: Parameters<typeof router.replace>[1]
+        ] = [localize(href, nextLocale)];
+        if (Object.keys(rest).length > 0) {
+          args.push(rest);
+        }
+        return router.replace(...args);
       },
-      prefetch(...[href, ...args]: Parameters<typeof router.prefetch>) {
-        return router.prefetch(localize(href), ...args);
+
+      prefetch(
+        href: string,
+        options?: Parameters<typeof router.prefetch>[1] & IntlNavigateOptions
+      ) {
+        const {locale: nextLocale, ...rest} = options || {};
+        const args: [
+          href: string,
+          options?: Parameters<typeof router.prefetch>[1]
+        ] = [localize(href, nextLocale)];
+        if (Object.keys(rest).length > 0) {
+          // @ts-expect-error TypeScript thinks `rest` can be an empty object
+          args.push(rest);
+        }
+        return router.prefetch(...args);
       }
     };
   }, [locale, router]);