https://github.com/nuxt-modules/i18n

I18n module for Nuxt
https://github.com/nuxt-modules/i18n

i18n javascript nuxt nuxt-module routing vue

Last synced: 8 minutes ago
JSON representation

I18n module for Nuxt

• Host: GitHub
• URL: https://github.com/nuxt-modules/i18n
• Owner: nuxt-modules
• License: mit
• Created: 2017-11-12T20:42:35.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T15:48:39.000Z (3 months ago)
• Last Synced: 2024-10-29T09:26:50.311Z (3 months ago)
• Topics: i18n, javascript, nuxt, nuxt-module, routing, vue
• Language: TypeScript
• Homepage: https://i18n.nuxtjs.org
• Size: 21.2 MB
• Stars: 1,728
• Watchers: 29
• Forks: 479
• Open Issues: 158
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Nuxt i18n](./docs/public/cover.png)](https://i18n.nuxtjs.org)

[![](https://img.shields.io/npm/v/%40nuxtjs%2Fi18n/latest.svg?style=flat-square)](https://npmjs.com/package/%40nuxtjs%2Fi18n)

[![](https://img.shields.io/npm/v/%40nuxtjs%2Fi18n-edge/latest.svg?style=flat-square)](https://npmjs.com/package/%40nuxtjs%2Fi18n-edge)

[![](https://img.shields.io/npm/dt/%40nuxtjs%2Fi18n.svg?style=flat-square)](https://npmjs.com/package/%40nuxtjs%2Fi18n)

[![](https://snyk.io/test/github/nuxt-community/i18n-module/badge.svg?style=flat-square)](https://snyk.io/test/github/nuxt-modules/i18n)



# Nuxt I18n

Internationalization (i18n) for Nuxt apps.

[📖 Read documentation](https://i18n.nuxtjs.org/)

## Features

- Integration with `vue-i18n`

- Route localization (static & dynamic)

- Lazy load translations

- SEO tag localization

- Layer support

## 🚀 Usage

### Install

1. Install the `@nuxtjs/i18n` module to your project

```sh

npx nuxi@latest module add i18n

```

2. Configure the module using the `i18n` key in `nuxt.config.ts`

```ts

{

  modules: [

    '@nuxtjs/i18n',

  ],

  i18n: {

    locales: [

      { code: 'en', language: 'en-US' },

      { code: 'fr', language: 'fr-FR' }

    ],

    defaultLocale: 'en',

  }

}

```

## Edge Release Channel

Nuxt I18n lands commits, improvements and bug fixes every day, you can opt in to test these before their release using the edge release channel.

### Opting In

Update `@nuxtjs/i18n` dependency inside `package.json`:

```diff

{

  "devDependencies": {

--    "@nuxtjs/i18n": "^8.0.0"

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

  }

}

```

Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.

### Opting Out

Update `@nuxtjs/i18n` dependency inside `package.json`:

```diff

{

  "devDependencies": {

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

++    "@nuxtjs/i18n": "^8.0.0"

  }

}

```

Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.

## Nuxt 2

Since Nuxt 2 has reached [its end-of-life (EOL) date](https://v2.nuxt.com/lts/) we are not actively maintaining support for this version, the last version to support Nuxt 2 is `v7`.

The codebase for this version can be found on the [`v7` branch](https://github.com/nuxt-modules/i18n/tree/v7) and its documentation [here](https://i18n.nuxtjs.org/docs/v7).

## 🔗 Links

- 🔖 [Release notes](./CHANGELOG.md)

- 👥 [Community](https://discord.nuxtjs.org/) (`🗨️❓ help` support forum)

## ©️ License

[MIT License](./LICENSE) - Copyright (c) Nuxt Community