nuxt-i18n

nuxt-i18n

i18n features for your Nuxt project

Documentation | Release notes

Co-maintainers welcome!

I've been lacking time to properly maintain the project lately and I would be really happy if anyone were interested in helping me maintaining nuxt-i18n! It looks like there are more and more projects using this module and we've had great contributions from the community. It's just getting hard to keep track of the issues and questions here and on CMTY so don't hesitate to get in touch if you're interested in taking a bigger part in the project!

Feel free to email me at the address that's in my profile.

Contribute to the module

• Fork the project and clone it in your existing Nuxt project:

cd my-nuxt-project/
mkdir modules/
git clone https://github.com/<username>/nuxt-i18n.git modules/nuxt-i18n
# or
git clone [e-mail]:<username>/nuxt-i18n.git modules/nuxt-i18n

• Edit your Nuxt config to use the local module:

// nuxt.config.js

{
  modules: [
    ['./modules/nuxt-i18n', {
      // options...
    }]
  ]
}

• Install the module's dependencies

cd modules/nuxt-i18n/
yarn

• Code, code, code!
• Run ESLint & Jest

yarn lint && yarn test

• Submit awesome PRs

Contribute to the documentation

• Fork and clone the project

git clone [e-mail]:<username>/nuxt-i18n.git
# or
git clone https://github.com/<username>/nuxt-i18n.git

• Install the dependencies

cd nuxt-i18n/
yarn

• Start the docs server

yarn docs:dev

• Write some doc by editing files in docs/ directory, if you're adding new pages, make sure you add them to the table of contents in docs/.vuepress/config

• Once you're done, submit that shiny PR!

Issues, questions & requests

Please use CMTY for any question you might have.

License

MIT License - Copyright (c) Nuxt Community

Changelog

6.0.0 (2019-07-20)

Bug Fixes

• routing: resolve localePath with fullPath instead of href (b827681)
• Disable seo by default (741ae12), closes #346
• update link to SEO metadata generation logic (#352) (10a5ff2)

Code Refactoring

• Disable setLocale & setMessages mutations by default (76c9978)
• Rename and flatten vuex options (8897ac6)

Features

• Dynamic route parameters translation (#345) (2d1d729), closes #79
• Use default locale's custom path if not defined for a locale (#354) (d30e5f0)

Performance Improvements

• Register global mixins from plugins (2ceb8e4)

BREAKING CHANGES

5.x to 6.x migration path

• Store module's options have been flattened and renamed
• The mutations responsible for syncing nuxt-i18n's store module with vue-i18n's locale and messages are now disabled by default, you'll need to manually re-enable them in the module's configuration
• preserveState is now set automatically when registering the store module and cannot be set via the configuration anymore
• Global seo option is now disabled by default. To preserve the previous behaviour, set seo: true in the module's options. Doc: https://nuxt-community.github.io/nuxt-i18n/seo.html