@nuxtjs/i18n

What is @nuxtjs/i18n?

@nuxtjs/i18n is a Nuxt.js module that provides internationalization (i18n) support for your Nuxt.js applications. It allows you to easily add multilingual support to your application, manage translations, and handle locale switching.

What are @nuxtjs/i18n's main functionalities?

Basic Setup

This code demonstrates the basic setup of the @nuxtjs/i18n module in a Nuxt.js project. It configures two locales (English and French) and sets English as the default locale. It also provides translation messages for the 'welcome' key in both languages.

{
  "modules": [
    "@nuxtjs/i18n"
  ],
  "i18n": {
    "locales": [
      { "code": "en", "name": "English" },
      { "code": "fr", "name": "Français" }
    ],
    "defaultLocale": "en",
    "vueI18n": {
      "fallbackLocale": "en",
      "messages": {
        "en": { "welcome": "Welcome" },
        "fr": { "welcome": "Bienvenue" }
      }
    }
  }
}

Locale Switching

This code demonstrates how to switch between locales in a Nuxt.js component using @nuxtjs/i18n. The $t function is used to translate the 'welcome' key, and the $i18n.setLocale method is used to change the current locale.

<template>
  <div>
    <p>{{ $t('welcome') }}</p>
    <button @click="$i18n.setLocale('en')">English</button>
    <button @click="$i18n.setLocale('fr')">Français</button>
  </div>
</template>

Dynamic Route Localization

This code demonstrates how to configure dynamic route localization with @nuxtjs/i18n. It maps the root path ('/') to '/accueil' for the French locale, allowing for localized URLs.

{
  "pages": {
    "index": {
      "en": "/",
      "fr": "/accueil"
    }
  }
}

Other packages similar to @nuxtjs/i18n

vue-i18n

vue-i18n is a powerful internationalization plugin for Vue.js. It provides similar functionalities to @nuxtjs/i18n but is not specifically tailored for Nuxt.js. It requires more manual setup when used with Nuxt.js compared to the seamless integration provided by @nuxtjs/i18n.

react-i18next

react-i18next is a popular internationalization library for React applications. It offers similar features such as translation management and locale switching. However, it is designed for React and not directly compatible with Nuxt.js, which is based on Vue.js.

next-i18next

next-i18next is an internationalization library for Next.js, a React framework. It provides similar functionalities to @nuxtjs/i18n but is specifically designed for Next.js applications, making it a better fit for React-based projects.

README

i18n for your Nuxt project

The next @nuxtjs/i18n for Nuxt 3

Status: v8 alpha

If you would like to use the stable version, please see the main branch

Usage

install with next tag

npm install @nuxtjs/i18n@next --save

install edge version

1. Add the following line to the dependencies in package.json:

"@nuxtjs/i18n": "npm:@nuxtjs/i18n-edge"

1. Run yarn or npm install.
2. Follow v8 documentation version https://v8.i18n.nuxtjs.org/ but keep in mind that not all features are supported yet and some things might be broken.

License

MIT License - Copyright (c) Nuxt Community

Changelog

v8.0.0-alpha.2 (2022-09-28T08:47:05Z)

This changelog is generated by GitHub Releases

   🚀 Features

• Support indetifierAttribue option for useLocaleHead  -  by @kazupon in https://github.com/nuxt-community/i18n-module/issues/1526
• Support strategy property API  -  by @kazupon in https://github.com/nuxt-community/i18n-module/issues/1533
• Support detect browser language fully  -  by @kazupon in https://github.com/nuxt-community/i18n-module/issues/1534

   🐞 Bug Fixes

• Remove wrong release section  -  by @kazupon <samp>(6ae1c)</samp>
• Upgrade vue-i18n-routing v0.1  -  by @kazupon <samp>(d1ee9)</samp>
• Improve error handling for vue-i18n v9 invalid message syntax  -  by @kazupon in https://github.com/nuxt-community/i18n-module/issues/1522
• Avoid deprecated use of params on vue-router  -  by @kazupon in https://github.com/nuxt-community/i18n-module/issues/1523
• Duplicate onLanguageSwitched calls  -  by @kazupon in https://github.com/nuxt-community/i18n-module/issues/1528
• Custom nested route path for configration  -  by @kazupon in https://github.com/nuxt-community/i18n-module/issues/1531
• module: Transpile edge aswell  -  by @dargmuesli in https://github.com/nuxt-community/i18n-module/issues/1516