chore: wrapping up

nuxt-modules · Mar 11, 2023 · b22cb7f · b22cb7f
1 parent 76104b1
commit b22cb7f
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 34 deletions.
diff --git a/docs/content/2.guide/15.migrating.md b/docs/content/2.guide/15.migrating.md
@@ -149,6 +149,10 @@ About details, See also [Lang Switcher](/api/lang-switcher#dynamic-route-paramet
 
 This option is no longer necessary, because i18n custom block is supported by [unplugin-vue-i18n](https://github.com/intlify/bundle-tools/tree/main/packages/unplugin-vue-i18n) **as default**.
 
+### Deprecated `onBeforeLanguageSwitch` and `onLanguageSwitched` function options
+
+These functions can now be triggered using Nuxt runtime hooks. Please refer to [runtime hooks](/guide/runtime-hooks) to see how to use these.
+
 ### Change some export APIs name on Nuxt context
 
 The following API will be changed to `$`:

diff --git a/docs/content/2.guide/2.runtime-hooks.md b/docs/content/2.guide/2.runtime-hooks.md
@@ -17,6 +17,8 @@ Parameters:
 - **initialSetup**: set to `true` if it's the initial locale switch that triggers on app load. It's a special case since the locale is not technically set yet so we're switching from no locale to locale.
 - **context**: the Nuxt app
 
+Returns: `string` or nothing
+
 ### `i18n:localeSwitched`
 
 Called right after the app's locale has been switched.

diff --git a/docs/content/4.API/3.vue-i18n.md b/docs/content/4.API/3.vue-i18n.md
@@ -102,15 +102,3 @@ Object of the current locale properties.
 - **Type**: `boolean`
 
 Whether `differentDomains` option is enabled.
-
-### onBeforeLanguageSwitch
-
-- **Type**: `Function`
-
-See [callbacks](/guide/callbacks)
-
-### onLanguageSwitched
-
-- **Type**: `Function`
-
-See [callbacks](/guide/callbacks)
diff --git a/specs/fixtures/plugins/i18nHooks.ts b/specs/fixtures/plugins/i18nHooks.ts
@@ -0,0 +1,15 @@
+import { defineNuxtPlugin } from '#imports'
+
+export default defineNuxtPlugin(nuxtApp => {
+ nuxtApp.hook('i18n:beforeLocaleSwitch', ({ oldLocale, newLocale, initialSetup }) => {
+ console.log('onBeforeLanguageSwitch', oldLocale, newLocale, initialSetup)
+
+ if (newLocale === 'en') {
+ return 'fr'
+ }
+ })
+
+ nuxtApp.hook('i18n:localeSwitched', ({ oldLocale, newLocale }) => {
+ console.log('onLanguageSwitched', oldLocale, newLocale)
+ })
+})
diff --git a/specs/callbacks.spec.ts → specs/runtime_hooks.spec.ts b/specs/callbacks.spec.ts → specs/runtime_hooks.spec.ts
@@ -8,12 +8,12 @@ await setup({
  browser: true,
  // overrides
  nuxtConfig: {
- plugins: [fileURLToPath(new URL(`../playground/plugins/i18n.ts`, import.meta.url))],
+ plugins: [fileURLToPath(new URL(`./fixtures/plugins/i18nHooks.ts`, import.meta.url))],
  i18n: { defaultLocale: 'en' }
  }
 })
 
-describe('onBeforeLanguageSwitch / onLanguageSwitched', () => {
+describe('beforeLocaleSwitch / localeSwitched', () => {
  test('<NuxtLink>', async () => {
  const home = url('/')
  const page = await createPage()

diff --git a/src/options.d.ts b/src/options.d.ts
@@ -37,7 +37,5 @@ export {
  NuxtI18nInternalOptions,
  DetectBrowserLanguageOptions,
  RootRedirectOptions,
- LanguageSwitchedHandler,
- BeforeLanguageSwitchHandler,
  LanguageSwitchedHandler
 } from './types'
diff --git a/src/runtime/types.d.ts b/src/runtime/types.d.ts
@@ -26,15 +26,15 @@ type BeforeLanguageSwitchHandler = (
  newLocale: string,
  initialSetup: boolean,
  context: NuxtApp
-) => Promise<unknown>
+) => Promise<string | void>
 
 /**
  * Called after the app's locale is switched.
  *
  * @param oldLocale - The app's locale before the switch
  * @param newLocale - The app's locale after the switch.
  */
-type LanguageSwitchedHandler = (oldLocale: string, newLocale: string) => Promise<unknown>
+type LanguageSwitchedHandler = (oldLocale: string, newLocale: string) => Promise<void>
 
 export interface ComposerCustomProperties {
  /**

diff --git a/src/runtime/utils.ts b/src/runtime/utils.ts
@@ -171,7 +171,7 @@ export async function loadAndSetLocale<Context extends NuxtApp = NuxtApp>(
  }
 
  // call onBeforeLanguageSwitch
- const localeOverride = onBeforeLanguageSwitch(i18n, oldLocale, newLocale, initial, context)
+ const localeOverride = await onBeforeLanguageSwitch(i18n, oldLocale, newLocale, initial, context)
  const localeCodes = getLocaleCodes(i18n)
  if (localeOverride && localeCodes && localeCodes.includes(localeOverride)) {
  if (localeOverride === oldLocale) {
@@ -201,11 +201,11 @@ export async function loadAndSetLocale<Context extends NuxtApp = NuxtApp>(
 
  // set the locale
  if (useCookie) {
- setCookieLocale(i18n, newLocale)
+ await setCookieLocale(i18n, newLocale)
  }
- setLocale(i18n, newLocale)
+ await setLocale(i18n, newLocale)
 
- onLanguageSwitched(i18n, oldLocale, newLocale)
+ await onLanguageSwitched(i18n, oldLocale, newLocale)
 
  ret = true
  return [ret, oldLocale]

diff --git a/src/types.ts b/src/types.ts
@@ -36,15 +36,6 @@ export type CustomRoutePages = {
  }
 }
 
-export type BeforeLanguageSwitchHandler = <Context = unknown>(
- oldLocale: string,
- newLocale: string,
- initialSetup: boolean,
- context: Context
-) => Promise<unknown>
-
-export type LanguageSwitchedHandler = (oldLocale: string, newLocale: string) => Promise<unknown>
-
 export type NuxtI18nOptions<Context = unknown> = {
  differentDomains?: boolean
  detectBrowserLanguage?: DetectBrowserLanguageOptions | false

diff --git a/test/__snapshots__/gen.test.ts.snap b/test/__snapshots__/gen.test.ts.snap
@@ -24,7 +24,7 @@ export const resolveNuxtI18nOptions = async (context) => {
  return nuxtI18nOptions
 }
 
-export const nuxtI18nOptionsDefault = Object({vueI18n: undefined,locales: [],defaultLocale: \\"\\",defaultDirection: \\"ltr\\",routesNameSeparator: \\"___\\",trailingSlash: false,defaultLocaleRouteNameSuffix: \\"default\\",strategy: \\"prefix_except_default\\",lazy: false,langDir: null,rootRedirect: null,detectBrowserLanguage: Object({\\"alwaysRedirect\\":false,\\"cookieCrossOrigin\\":false,\\"cookieDomain\\":null,\\"cookieKey\\":\\"i18n_redirected\\",\\"cookieSecure\\":false,\\"fallbackLocale\\":\\"\\",\\"redirectOn\\":\\"root\\",\\"useCookie\\":true}),differentDomains: false,baseUrl: \\"\\",dynamicRouteParams: false,customRoutes: \\"page\\",pages: Object({}),skipSettingLocaleOnNavigate: false,onBeforeLanguageSwitch: (() => \\"\\"),onLanguageSwitched: (() => null),types: undefined,debug: false})
+export const nuxtI18nOptionsDefault = Object({vueI18n: undefined,locales: [],defaultLocale: \\"\\",defaultDirection: \\"ltr\\",routesNameSeparator: \\"___\\",trailingSlash: false,defaultLocaleRouteNameSuffix: \\"default\\",strategy: \\"prefix_except_default\\",lazy: false,langDir: null,rootRedirect: null,detectBrowserLanguage: Object({\\"alwaysRedirect\\":false,\\"cookieCrossOrigin\\":false,\\"cookieDomain\\":null,\\"cookieKey\\":\\"i18n_redirected\\",\\"cookieSecure\\":false,\\"fallbackLocale\\":\\"\\",\\"redirectOn\\":\\"root\\",\\"useCookie\\":true}),differentDomains: false,baseUrl: \\"\\",dynamicRouteParams: false,customRoutes: \\"page\\",pages: Object({}),skipSettingLocaleOnNavigate: false,types: undefined,debug: false})
 
 export const nuxtI18nInternalOptions = Object({__normalizedLocales: [Object({\\"code\\":\\"en\\"})]})
 export const NUXT_I18N_MODULE_ID = \\"@nuxtjs/i18n\\"
@@ -141,7 +141,7 @@ export const resolveNuxtI18nOptions = async (context) => {
  return nuxtI18nOptions
 }
 
-export const nuxtI18nOptionsDefault = Object({vueI18n: undefined,locales: [],defaultLocale: \\"\\",defaultDirection: \\"ltr\\",routesNameSeparator: \\"___\\",trailingSlash: false,defaultLocaleRouteNameSuffix: \\"default\\",strategy: \\"prefix_except_default\\",lazy: false,langDir: null,rootRedirect: null,detectBrowserLanguage: Object({\\"alwaysRedirect\\":false,\\"cookieCrossOrigin\\":false,\\"cookieDomain\\":null,\\"cookieKey\\":\\"i18n_redirected\\",\\"cookieSecure\\":false,\\"fallbackLocale\\":\\"\\",\\"redirectOn\\":\\"root\\",\\"useCookie\\":true}),differentDomains: false,baseUrl: \\"\\",dynamicRouteParams: false,customRoutes: \\"page\\",pages: Object({}),skipSettingLocaleOnNavigate: false,onBeforeLanguageSwitch: (() => \\"\\"),onLanguageSwitched: (() => null),types: undefined,debug: false})
+export const nuxtI18nOptionsDefault = Object({vueI18n: undefined,locales: [],defaultLocale: \\"\\",defaultDirection: \\"ltr\\",routesNameSeparator: \\"___\\",trailingSlash: false,defaultLocaleRouteNameSuffix: \\"default\\",strategy: \\"prefix_except_default\\",lazy: false,langDir: null,rootRedirect: null,detectBrowserLanguage: Object({\\"alwaysRedirect\\":false,\\"cookieCrossOrigin\\":false,\\"cookieDomain\\":null,\\"cookieKey\\":\\"i18n_redirected\\",\\"cookieSecure\\":false,\\"fallbackLocale\\":\\"\\",\\"redirectOn\\":\\"root\\",\\"useCookie\\":true}),differentDomains: false,baseUrl: \\"\\",dynamicRouteParams: false,customRoutes: \\"page\\",pages: Object({}),skipSettingLocaleOnNavigate: false,types: undefined,debug: false})
 
 export const nuxtI18nInternalOptions = Object({__normalizedLocales: [Object({\\"code\\":\\"en\\"})]})
 export const NUXT_I18N_MODULE_ID = \\"@nuxtjs/i18n\\"
@@ -172,7 +172,7 @@ export const resolveNuxtI18nOptions = async (context) => {
  return nuxtI18nOptions
 }
 
-export const nuxtI18nOptionsDefault = Object({vueI18n: undefined,locales: [],defaultLocale: \\"\\",defaultDirection: \\"ltr\\",routesNameSeparator: \\"___\\",trailingSlash: false,defaultLocaleRouteNameSuffix: \\"default\\",strategy: \\"prefix_except_default\\",lazy: false,langDir: null,rootRedirect: null,detectBrowserLanguage: Object({\\"alwaysRedirect\\":false,\\"cookieCrossOrigin\\":false,\\"cookieDomain\\":null,\\"cookieKey\\":\\"i18n_redirected\\",\\"cookieSecure\\":false,\\"fallbackLocale\\":\\"\\",\\"redirectOn\\":\\"root\\",\\"useCookie\\":true}),differentDomains: false,baseUrl: \\"\\",dynamicRouteParams: false,customRoutes: \\"page\\",pages: Object({}),skipSettingLocaleOnNavigate: false,onBeforeLanguageSwitch: (() => \\"\\"),onLanguageSwitched: (() => null),types: undefined,debug: false})
+export const nuxtI18nOptionsDefault = Object({vueI18n: undefined,locales: [],defaultLocale: \\"\\",defaultDirection: \\"ltr\\",routesNameSeparator: \\"___\\",trailingSlash: false,defaultLocaleRouteNameSuffix: \\"default\\",strategy: \\"prefix_except_default\\",lazy: false,langDir: null,rootRedirect: null,detectBrowserLanguage: Object({\\"alwaysRedirect\\":false,\\"cookieCrossOrigin\\":false,\\"cookieDomain\\":null,\\"cookieKey\\":\\"i18n_redirected\\",\\"cookieSecure\\":false,\\"fallbackLocale\\":\\"\\",\\"redirectOn\\":\\"root\\",\\"useCookie\\":true}),differentDomains: false,baseUrl: \\"\\",dynamicRouteParams: false,customRoutes: \\"page\\",pages: Object({}),skipSettingLocaleOnNavigate: false,types: undefined,debug: false})
 
 export const nuxtI18nInternalOptions = Object({__normalizedLocales: [Object({\\"code\\":\\"en\\"})]})
 export const NUXT_I18N_MODULE_ID = \\"@nuxtjs/i18n\\"