Options

See the Setup section on where to set the module options.

baseUrl

• type: string or function
• default: ''

The fallback base URL to use as a prefix for alternate URLs in hreflang tags. By default VueRouter's base URL will be used and only if that is not available, fallback URL will be used.

Can also be a function (will be passed a Nuxt Context as a parameter) that returns a string. Useful to make base URL dynamic based on request headers.

locales

• type: array
• default: []

List of locales supported by your app. Can either be an array of codes (['en', 'fr', 'es']) or an array of objects for more complex configurations:

[
  { code: 'en', iso: 'en-US', file: 'en.js', dir: 'ltr' },
  { code: 'ar', iso: 'ar-EG', file: 'ar.js', dir: 'rtl' },
  { code: 'fr', iso: 'fr-FR', file: 'fr.js' },
]

When using an object form, the properties can be:

• code (required) - unique identifier of the locale
• iso (required when using SEO features) - A language-range used for SEO features and for matching browser locales when using detectBrowserLanguage functionality. Should use the language tag syntax as defined by the IETF's BCP47, for example:
  • 'en' (language subtag for English)
  • 'fr-CA' (language+region subtags for French as used in Canada)
  • 'zh-Hans' (language+script subtags for Chinese written with Simplified script)
• file - the name of the file. Will be resolved relative to langDir path when loading locale messages from file
• dir (from v6.19.0) The dir property specifies the direction of the elements and content, value could be 'rtl', 'ltr' or 'auto'.
• domain (required when using differentDomains) - the domain name you'd like to use for that locale (including the port if used)
• ... - any custom property set on the object will be exposed at runtime. This can be used, for example, to define the language name for the purpose of using it in a language selector on the page.

You can access all the properties of the current locale through the localeProperties property. When using an array of codes, it will only include the code property.

export default {
  head () {
    return this.$nuxtI18nHead()
  }
}

defaultDirection

• type: string
• default: ltr

The app's default direction. Will only be used when dir is not specified.

defaultLocale

• type: string or null
• default: null

The app's default locale. Should match code of one of defined locales.

When using prefix_except_default strategy, URLs for locale specified here won't have a prefix. It's recommended to set this to some locale regardless of chosen strategy, as it will be used as a fallback locale when navigating to a non-existent route.

sortRoutes

• type: boolean
• default: true

Whether to sort routes by using the sortRoutes function from the @nuxt/utils package.

While Nuxt sorts the routes itself, it does that before @nuxtjs/i18n has added its own generated routes so the module has to re-sort them again. This is necessary as otherwise some routes might become inaccessible due to being shadowed by more generic routes. If you are adding custom routes programmatically, the sorting might change the order of your custom routes in unexpected ways so in that case you might want to disable sorting and handle that yourself. In that case you have to ensure the correct order yourself so that, for example, a more generic route like /en/* doesn't shadow a more specific /en/foo/* route (the latter should be registered first to work properly).

strategy

• type: string
• default: 'prefix_except_default'

Routes generation strategy. Can be set to one of the following:

• 'no_prefix': routes won't have a locale prefix
• 'prefix_except_default': locale prefix added for every locale except default
• 'prefix': locale prefix added for every locale
• 'prefix_and_default': locale prefix added for every locale and default

lazy

• type: boolean or LazyOptions
• default: false

See also Lazy-load translations.

Whether the translations should be lazy-loaded. If this is enabled, you MUST configure the langDir option, and locales must be an array of objects, each containing a file key.

Loading locale messages lazily means that only messages for currently used locale (and for the fallback locale, if different from current locale) will be loaded on page loading.

LazyOptions

The value can also be set to an object instead of the value true to override configuration options related to lazy loading. Supports the following optional properties:

skipNuxtState

• type: boolean
• default: true

Whether the translation messages for the current locale should be injected into Nuxt state and re-used on the client-side. Read more.

langDir

• type: string or null
• default: null

Directory that contains translation files to load. Can be used with or without lazy-loading (the lazy option). Use Webpack paths like ~/locales/ (with trailing slash).

detectBrowserLanguage

• type: object
• default:

  {
    alwaysRedirect: false,
    fallbackLocale: '',
    redirectOn: 'root',
    useCookie: true,
    cookieAge: 365,
    cookieCrossOrigin: false,
    cookieDomain: null,
    cookieKey: 'i18n_redirected',
    cookieSecure: false,
  }

  Copy to clipboard

Enables browser language detection to automatically redirect visitors to their preferred locale as they visit your site for the first time.

See also Browser language detection for a guide.

Supported properties:

• alwaysRedirect (default: false) - Set to always redirect to the value stored in the cookie, not just on first visit.
• fallbackLocale (default: null) - If none of the locales match the browser's locale, use this one as a fallback.
• redirectOn (default: root) - Supported options:
  • all - detect browser locale on all paths.
  • root (recommended for improved SEO) - only detect the browser locale on the root path (/) of the site. Only effective when using strategy other than 'no_prefix'.
  • no prefix - a more permissive variant of root that will detect the browser locale on the root path (/) and also on paths that have no locale prefix (like /foo). Only effective when using strategy other than 'no_prefix'.
• useCookie (default: true) - If enabled, a cookie is set once the user has been redirected to browser's preferred locale, to prevent subsequent redirections. Set to false to redirect every time.
• cookieAge (default: 365) - Sets the max age of the cookie in days.
• cookieKey (default: 'i18n_redirected') - Cookie name.
• cookieDomain (default: null) - Set to override the default domain of the cookie. Defaults to the host of the site.
• cookieCrossOrigin (default: false) - When true, sets the flags SameSite=None; Secure on the cookie to allow cross-domain use of the cookie (required when app is embedded in an iframe).
• cookieSecure (default: false) - Sets the Secure flag for the cookie.

Set to false to disable.

rootRedirect

• type: string or object or null
• default: null

Set to a path to which you want to redirect users accessing the root URL (/). Accepts either a string or an object with statusCode and path properties. E.g

{
  statusCode: 301,
  path: 'about-us'
}

differentDomains

• type: boolean
• default: false

Set this to true when using different domains for each locale. If enabled, no prefix is added to your routes and you MUST configure locales as an array of objects, each containing a domain key. Refer to the Different domains for more information.

parsePages

• type: boolean
• default: true

Whether custom paths are extracted from page files using babel parser.

pages

• type: object
• default: {}

If parsePages option is disabled, the module will look for custom routes in the pages option. Refer to the Routing for usage.

vuex

• type: object or false
• default: { moduleName: 'i18n', syncRouteParams: true }

Registers a store module used for syncing app's i18n state. Set to false to disable.

Properties:

• moduleName (default: 'i18n') - The module's namespace.
• syncRouteParams (default: true) - Enables a setRouteParams mutation for using custom route names with dynamic routes. See more information in Dynamic route parameters

vueI18n

• type: object or string
• default: {}

Configuration for the vue-i18n library that is used internally by this module. See full documentation at http://kazupon.github.io/vue-i18n/api/#constructor-options

export default context => {
  return {
    modifiers: {
      snakeCase: (str) => str.split(' ').join('-')
    }
  }
}

vueI18nLoader

• type: boolean
• default: false

If true, vue-i18n-loader is added to Nuxt's Webpack config, allowing to define locale messages per-page using a custom i18n block.

onBeforeLanguageSwitch

• type: function
• default: (oldLocale, newLocale, isInitialSetup, context) => {}

A listener called before the app's locale is changed. Can override the locale that is about to be set.

See callbacks

onLanguageSwitched

• type: function
• default: (oldLocale, newLocale) => {}

A listener called after app's locale has changed.

See callbacks

skipSettingLocaleOnNavigate

• type: boolean
• default: false

If true, the locale will not be set when navigating to a new locale. This is useful if you want to wait for the page transition to end before setting the locale yourself using finalizePendingLocaleChange. See more information in Wait for page transition.

defaultLocaleRouteNameSuffix

• type: string
• default: 'default'

Internal suffix added to generated route names for default locale, if strategy is prefix_and_default. You shouldn't need to change this.

routesNameSeparator

• type: string
• default: '___'

Internal separator used for generated route names for each locale. You shouldn't need to change this.