Compare Versions - next-i18next

refactor: reuse existing i18next instance #2226 -> If you use client side pages (not lazy loading translations), like described here, make sure you set the partialBundledLanguages option to true, like here.

14.0.3

fix: correct namespacesRequired type in serverSideTranslations #2203

14.0.2

try to fix namespacesRequired in serverSideTranslations is not type-safe anymore #2201

14.0.1

try to fix namespacesRequired in serverSideTranslations is not type-safe anymore #2201

14.0.0

requires i18next >= v23.0.1
requires react-i18next >= v13.0.0

13.3.0

using a custom backend on server side should also lazy load the passed namespaces

13.2.2

pageProps may be undefined on strange setups #2109"

13.2.1

types: fix serverSideTranslations args #2104"

13.2.0

types: Update serverSideTranslation args type #2097"

13.1.6

fix: allow user provided affixes to be used without providing localeStructure #2100"

13.1.5

#2089, more stable impelementation of "feat(server-side): custom default config path #2084"

13.1.4

revert #2084

13.1.3

another code snippet for #2084 to try to fix for dynamic pages

13.1.2

different code snippet for #2084 to try to fix for dynamic pages

13.1.1

log config path if no config found

13.1.0

feat(server-side): custom default config path #2084

13.0.3

Error if custom localeStructure provided, but no ns option defined.

13.0.2

Fix

Types: DefaultNamespace import, see #2061.

13.0.1

Fix

Fix missing i18n.localeDetection in UserConfig, see #2057.
Update examples to latest i18next in #2058

Caution

If you're experiencing typecheck errors regarding keys: ensure i18next is at least ^22.4.3 in your package.json (then run install), see #2058.

13.0.0

The v13.0.0 release is a major version to improve stability and general experience. It comes with 2 easy changes related to installation. Existing code shouldn't be impacted. Details can be found in the UPGRADING.md document.

Breaking changes

react-i18next and i18next have been moved to peer-dependencies. They must be installed in your app (#1966)
```
# Add react-i18next > 12.0.0 and i18next > 22.0.4 to your app dependencies  
npm install react-i18next i18next --save  # NPM
yarn add react-i18next i18next            # Yarn
pnpm add react-i18next i18next --save     # PNPM
```
This might solve issues with duplicates and multiple i18n context instances. If you encounter any issue, please read the Troubleshoot doc before posting an issue.
Types augmentations are now handled by i18next instead of react-i18next (#1997). See the upgrade document here.

New

Support for NextJs 13 (excluding new experimental layout / rsc)
Upgrade to i18next v22 and react-i18next v12, see #1966
Support for node 18 lts #2017

Fix

Fix types for appWithTranslation #1987

New minimum versions

We've dropped support for nextjs < 12.0.0 / react < 17.0.2 (#1983) and node < 14 (#1974).

12.1.0

fix: appWithTranslation re-renders _app when the locale is changed (#1954)
feat: introduce onPreInitI18next option (#1960)

12.0.1

fix: fallbackLng if namespaces are undefined (#1943 closes #1941)

12.0.0

Why a major version? The following changes could lead to more languages being loaded, which could increase the page size.

feat: improve fallback language handling (#1927)
feat: add support for nonExplicitSupportedLngs (#1930)

11.3.0

feat: introduce extraLocales (#1916)

11.2.2

fix: pass namespaces to the client also for custom backends (#1913)

11.2.1

fix: pass namespaces to the client (#1912 closes #1839)

11.2.0

feat: support nested namespace structure (#1911)

11.1.1

fix: remove postinstall script

11.1.0

first release with new project ownership
update most dependencies
update docs and example
feat: support default locale by ignoring it (#1679)

11.0.0

Features:

Allow client side translation loading (8132efd)

Documentation:

Link to react-i18next config options (422a0f3)

10.5.0

Chores:

Upgrade react-i18next (ae25f93)

10.4.0

Bug fixes:

Respect configOverride.resources (8d13429)

Chores:

Mute vercel bot (8999125)

Features:

Allow function type for localePath (4ed12ec)

10.3.0

Documentation:

Clarify config for custom interpolation suffix/prefix (5fff8de)

Bug fixes:

appWithTranslation useMemo bug (null locale) 584f534

10.2.0

Features:

Expose Translation component from react-i18next

10.1.0

Chores:

Added note for Vercel/Netlify using serverSideTranslations (6b5841b)

10.0.1

Bug fixes:

Set interpolation.escapeValue to false (c9056a5)

10.0.0

Breaking changes:

Remove interpolation from defaultConfig (bf1f608)

9.2.0

Documentation:

Note for asynchronous backends (d761e76)

Chores:

Bump i18next to v21.5.3 (a103cb8)

9.1.0

Refactor:

Set config.react.useSuspense to false (93d4f88)

9.0.1

Bug fixes:

Pin i18next-fs-backend to >=1.1.4

9.0.0

Breaking changes:

Remove support for Node v10 (1bf723f)
Bump i18next to v21 (21a30fe)

Features:

Make appWithTranslation generic over AppProps type (76b8994)

Refactor:

Remove router.locale check (d2d1b73)

8.10.0

Bug fixes:

Move @types/i18next-fs-backend to dev deps (a7939f2)

8.9.0

Documentation:

Update README with addResourceBundle info (d8ad005)

8.8.0

Documentation:

Improve README.md (52b157d)

Refactor:

Move hook out of condition (e7eb577)
Better support for shallow route changes (1f98177)

8.7.0

Features:

Add reloadOnPrerender option to reload resources (2c08b29)

8.6.0

Documentation:

Fix typo in migration doc (a1339b5)

Chores:

Removed compatibility with getInitialProps info in migration guide (3679e7f)

8.5.5

Bug fixes:

Respect user-defined prefix/suffix when looking for default NS (315531a)

8.5.4

Bug fixes:

Set client side backend options only if there is no custom backend (5ed1e91)

8.5.3

Bug fixes:

Only import default config if no userConfig is passed (28cd9c6)

8.5.2

Bug fixes:

Fixed issue where empty requiredNamespaces array returns all namespaces instead of no namespaces (a09a69b)

8.5.1

Bug fixes:

fix: serverSideTranslations loading all locales (29147f5)

8.5.0

Bug fixes:

Export Resources and DefaultNamespace from typings (fb5cbce)
Client config ns assignment logic (336ed9c)

Documentation:

Add v8 migration documentation (e76d9b0)

8.4.0

Documentation:

docs: Update README.md (59b85a0)

Bug fixes:

Fix 1181: Missing namespaces if they are not in the defaultLanguage (7474c93)

8.3.0

Bug fixes:

fix: i18n.getFixedT to return correct t function (78d5d2e)

Chores:

build: install @babel/runtime to satisfy dependency of @babel/plugin-transform-runtime (deeec29)

Documentation:

docs: Update README with interpolation format example (78e1adf)

8.2.0

Bug fixes:

Fix CVE-2021-23346 vulnerability (9f0a291)

Documentation:

Update README Dockerfile (d57164d)

8.1.3

Bug fixes:

Resolve memory leak, by cloning always from the main instance (2911d35)

8.1.2

Chores:

Upgrade jest (8973022)

Refactor:

Some tweaks to the example demo (c6fc2e3)

Bug fixes:

strip public prefix correctly on the client (ff9b5fa)
create i18next clone to fix #1063 (15c65ae)

8.1.1

Bug fixes:

fix: generate types using tsc and stop shipping the /src directory (770170c)
fix: prevent loading translations on each request (e7c5fad)

8.1.0

Features:

Add globalI18n (7fd4f09)

8.0.6

Refactor:

refactor: Add NextJsAppProps type (301ccf5)

8.0.5

Refactor:

refactor: Add @types/i18next-fs-backend as dependency (86e5768)

8.0.4

Refactor:

refactor: Enable TypeScript strict mode (365921d)

8.0.3

Documentation:

docs: Update sponsors section (d9688f3)

8.0.2

Bug fixes:

fix: Ship src dir to support TypeScript types (bd5d159)

8.0.1

Chores:

chore(deps): bump ini from 1.3.5 to 1.3.7 (3f4f777)
chore(deps): bump ini from 1.3.5 to 1.3.8 in /examples/simple (2943061)

Bug fixes:

fix: Restore getAllNamespaces functionality (cfbd7aa)

8.0.0

Major rewrite of package, leveraging the built-in internationalised routing provided by NextJs.

For new projects, or migrating existing projects, please refer to the new documentation.

7.0.1

Chores:

Bump bl from 1.2.2 to 1.2.3 (d441f9e)

7.0.0

Breaking changes:

If using a custom backend, fs checks and fallback to static dir will no longer be performed

Chores:

Bump Next to v9.5.4 (210f6d2)

Bug fixes:

Handles "cimode" correctly (a538ad4)
Handling of backend options if using with other backends (25c4ce9)

6.0.3

Chores:

Bump tree-kill from 1.2.1 to 1.2.2 (c37d2da)
Bump lodash from 4.17.11 to 4.17.20 (5a6e0fb)
Bump puppeteer from 1.11.0 to 1.13.0 (2c1f182)

Documentation:

Added FAQ about how to use multiple files (5ebe924)
Add required Next.js version to README (9a4ca30)
Add a TypeScript usage section to the README (b3fb7a2)

Bug fixes:

I18nContext exported as type (b38b8a2)

6.0.2

Chores:

Bump elliptic from 6.5.2 to 6.5.3 (d042d64)

6.0.1

Documentation:

Update next export note (875558c)

6.0.0

Breaking Changes:

Upgrade i18next dependencies (205d11e)
Set cookieSameSite to strict by default (ecb70d6)
Remove dependency on detect-node (54f8195)
Swap middleware execution to expose req.i18n again during SSR (01069e3)

5.1.0

Features:

Add I18nContext export (cf2858a)

5.0.0

Breaking Changes:

The localePath config option is now required, and must be an absolute path (recommendation is to use path.resolve)
The localeSubpath functionality is now supported via NextJs rewrites
Custom servers and use of middlewares are now actively discouraged

4.5.0

Features:

Allow config.otherLanguages to be empty (e96aadb)

Dependencies:

Move @types/express to dependencies (41f93d6)

4.4.2

Docs:

Modified the example app and the instructions as per issue (037543f)
Remove david-dm shield (dd5e793)

4.4.1

Bug Fixes:

Fix i18next CJS issues (9eb6add, bdd48e3)
Fix i18next-http-middleware cookie bug (ff9239b)

Chores:

Upgrade i18next dependencies (1c2cd29)
Update lockfiles (fc91d9a)

4.4.0

Chores:

Bump https-proxy-agent from 2.2.1 to 2.2.4 (56d75d0)
Update i18next dependencies (a721b2e)

Refactor:

Switch to i18next-http-middleware (65ec703)

4.3.0

Chores:

Bump acorn from 5.7.3 to 5.7.4 (f84c786)
Upgrade i18next-express-middleware (294ab6f)

4.2.1

Documentation:

Specify the need for getInitialProps in stateless _app (881a3cc)

4.2.0

Features:

Make shallowRender configurable (f8a555e)

4.1.0

Features:

Add initPromise to NextI18Next class (8fcf555)

4.0.0

Features:

Add /api/ to ignoreRoutes (7b359b2)

Chores:

Upgrade i18next to v19 (fcee908)

3.0.1

Bug Fixes:

Check if pathname is string in subpath-is-present (a1c5aff)

3.0.0

Features:

Public dir support (99f82cd)

2.1.1

Bug Fixes:

Dedupe languages (e48f7e9)
TypeScript declaration conflict error (154b379)

2.1.0

Chores:

Bump mixin-deep from 1.3.1 to 1.3.2 (669f5e8)
Bump eslint-utils from 1.3.1 to 1.4.3 (4aa7b6a)
Bump handlebars from 4.1.0 to 4.5.3 (c3bd634)

2.0.1

Bug Fixes:

Do not ignore routes at i18nextMiddleware level (d0b874a)
Set stackTraceLimit properly in createConsoleLog (a0dae6a)
Remove forwardedRef prop from NextLink (4c749f8)

2.0.0

Documentation:

Add item about changes to package.json (234435f)
Remove IE11 warning (a457f11)

Chores:

Remove the <Container> component from custom <App> (1c1de39)
Update i18next dependencies (67db368)

1.2.1

Bug Fixes:

Prevent removing subPath when not required (ca7d241)
Update lng query param when changeLanguage is called in middleware (5748fb0)

Tests:

Refactor middleware tests (95b6e90)

1.2.0

Testing:

Target multiple NodeJs versions in CircleCI builds (8cae67e)

Chores:

Add tsconfig to npmignore (a04f7e0)

Bug Fixes:

Modify middleware approach to fix 404s (4565e7f)

1.1.2

Documentation:

Remove trailing slash from docs (d189349)

Bug Fixes:

Don't call next on redirect in middleware (6ce951b)

1.1.1

Documentation:

Update accessing current language section (6682b15)

Bug Fixes:

Export WithTranslation props type for TypeScript (85fe39d)

1.1.0

Refactor:

Use initImmediate in SSR (db543b9)

Chores:

Add yarn.lock to npmignore (680a55b)

1.0.0

Features:

Custom localeSubpaths values (09be96f)

Documentation:

Update localeSubpaths info (cfbda74)

Bug Fixes:

Memory leak regression (cefb0f7)
Add trailing slash to ignoreRoutes (a13e6f4)

Refactor:

Use window instead of process.browser in isServer

0.54.0

Bug Fixes:

Only call router.replace when lang has changed (0e27ac7)
Update of i18next and react-i18next versions (cb60360)

Chores:

Upgrade lockfile (f567272)

Refactor:

Refine clean script (internal) (d2b9adf)

0.53.1

Bug Fixes:

Fix TypeScript exported typings (322b90e)

Tests:

Cover default export type (e499b99)

0.53.0

Refactor:

Migrate to TypeScript (8803371)

0.52.1

Bug Fixes:

Use asPath for dynamic client side routing (0b314a6)

0.52.0

Documentation:

Remove broken Greenkeeper badge (a1b2322)

Features:

Export withTranslation as an independent function (e3b3ee6)

0.51.1

Bug fixes:

Do not call router events in SSR (a2a2075)

0.51.0

Refactor:

Use router.replace after every lang change (d7623f6)
Use core-js v2 to decrease bundle size (311c38b)

0.50.0

Docs:

Add strictMode to config options table (c3f6157)

Refactor:

Add useBuiltIns and bundlesize (4e7ff04)

0.49.0

Docs:

Add BrowserStack attribution (aa9a400)

Bug fixes:

Update Babel deps and use core-js (af3ae61)
Root path redirect for localeSubpaths (aeb8959)
Update CircleCI steps (f38ff69)

0.47.0

Features:

Add package version to demo (a70539d)
Delay language change until after loading namespaces (073bf5d)
Add Procfile for Heroku deployment (b2c0b60)

Chores:

Update npmignore (422a0a7)

Docs:

Add demo to README (d362a50)

Testing:

Validate exported types (5644ae5)

Refactor:

Convert simple example to functional components and add styling (9295d04)

0.46.0

Chores:

Upgrade NextJs to v9 (96da934)

Features:

Re-export types from i18next (1ee689a)

0.45.0

Bug Fixes:

Upgrade react-i18next to v10.11.3 to fix fs isClone bug (040cd0b)

Chores:

Update husky to the latest version (2412e2a)

Features:

Validate defaultNS exists via fs (71bc3df)
Re-export type WithTranslation from react-i18next (8c32ad0)

0.44.0

Features:

Types for react-i18next v10 (af1ac04)

Chores:

Update i18next to the latest version (e6a96b7)

0.43.0

Bug Fixes:

Link no longer passed props.lng with react-i18next v10 (89cce34)

Refactor:

Add react-i18next v10 withNamespaces warning (459224b)

Features:

Update types.d.ts with useTranslation (ed81b2f)

0.42.0

Refactor:

Update i18next to the latest version (7ed1cd6)
Update i18next-xhr-backend to the latest version (22b02aa)
Remove rm -rf from build scripts (0dd354b)

Docs:

Update to reflect absence of props.lng (1313f81)

Features:

Add useTranslation (a3477cf)

0.41.0

Refactor:

Upgrade react-i18next to v10 (4657514)

Bug fixes:

Do not call next() after redirect (029324c)

Docs:

Add note to README about serverless (4f8cf80)

0.40.1

Docs:

Create CONTRIBUTING.md (c02dadf)

Refactor:

Added the TypeScript declaration file for middleware (bc96d30)

Feature:

Load main language when initial language is locale specific (217aad1)

0.40.0

Docs:

Add readme note to inform about polyfill solution for browsers (c49dd88)
Add section on accessing current language (a78dcc5)

Refactor:

Add localeExtension config option and clean up config procedure (bdea075)

0.39.0

Features:

Support complex fallbackLng logic from i18next (6f69e7c)

0.38.0

Refactor:

Remove pretty-error (3bf77ee)
Move setting of config.backend to default configuration (56363e4)

Fix:

Add linking to simple example (903d54c)

Docs:

Update docs to clarify existing i18next paradigms (2a46e53)
Add note to README about next/head (eefe004)

0.37.0

Refactor:

Rename withConfig to withInternals (b650001)

Features:

Add support for full URLs in Link with localeSubpaths (2aa2204)

0.36.6

Bug fixes:

Remove T from return types (53525e0)
Add config to NextI18Next declaration (84fb565)

0.36.5

Bug fixes:

Add strictMode to types (399947c)

0.36.4

Bug fixes:

Remove extends of withNamespaces (eb4a932)

0.36.3

Features:

Add return type for withNamespaces function (d85e18c)

Bug fixes:

Return Component type in appWithTranslation (8ebcc46)

0.36.2

Features:

Improve TS types (b93814b)

0.36.1

Fix:

Add React.ElementType to appWithTranslation parameter type (9ab6c7c)

Chore:

Add README to simple example (d8a6e51)
Change NextI18Next import in example (9fdbefb)

0.36.0

Refactor:

Transpile CJS to NextJs default target (2de3dee)

0.35.2

Fix:

Protect against req.i18n being undefined in lng-from-req (5818432)

0.35.1

Fix:

Throw an error for breaking change on localeSubpaths

0.35.0

Refactor:

Change locale subpaths to a string enum (a444400)

Breaking change: localeSubpaths is now a string, not a boolean.

0.34.0

Features:

Add typescript types (f3b3a31)

0.33.0

Refactor:

lngPathCorrector (8bf6fb4)
Remove custom-routing example and move approach into docs (a4a16f6)

Chore:

Pin react-i18next to v9.0.10 (aef9d97)

0.32.0

Fixes:

i18n.on event listener memory leak (d1a15d0)

Features:

Deep merge nested config options (47b4039)

0.31.0

Features:

Export Router for imperative routing (8f121aa)

Chores:

Update dev dependencies (89a0937)

0.30.0

Chore:

Update i18next deps

0.29.0

Refactor:

Babel setup (1fdb502)

Note: we are no longer using the add-module-exports plugin for ES module exports at dist/es/index.js, so if you using CJS you'll need to add a .default, as in: require('next-i18next').default. Otherwise you can specifically consume dist/commonjs/index.js.

0.28.0

Fix:

Fallback language for non-supported language headers (eb40afd)

Chore:

Create MIT License

0.27.0

Changes:

Use lngPathCorrector within Link component
Cease all polyfilling via Babel

0.26.1

Update .npmignore.

0.26.0

Removed runtime polyfill and restructured dependencies.

0.25.0

Add peer dependencies to package.json.

0.24.0

Fix concurrency issues due to i18n singleton - fixes #135.

0.23.7

Add named exports to docs.

0.23.6

Add named exports to docs.

0.23.5

Revert v0.23.4.

0.23.4

Added module field for ES6 support.

0.23.3

Improved documentation, added issue templates.

0.23.2

Bug Fixes:

Set fallbackLng properly in non-English cases
Throw otherLanguages error prior to createI18NextClient
Use prepublishOnly instead of prepare

0.23.1

Bug Fixes:

Add core-js as an explicit dependency

0.23.0

Breaking changes:

Refactored next-i18next-middleware to behave more like common express middleware, via #90.

Use of next-i18next/middleware has changed completely, and is reflected in the docs.

This refactor allows for support of custom routes, improved query string support, and more.

0.22.0

Bug Fixes:

Query string now preserved during language change on localeSubpaths = true

DX:

Add error message if wrappedComponentProps.pageProps is undefined

Features:

Add customDetectors support
Refactor appWithTranslation to work with custom routes

0.21.0

Fixed incorrect peer deps, and added a console error if config.otherLanguages is empty.

0.20.0

Chores:

Updated deps
Add GreenKeeper

Refactoring:

Create withConfig HOC for internal use

Bug fixes:

Fix double call of getInitialProps
Use url.format for Link as formatting

0.19.1

Bug fixes:

Add @babel/polyfill for IE 11 support
Fallback to Component.name, etc, for warning messages
Fix serverLanguageDetection disable logic

0.19.0

Lots of bug fixes, including:

Removal of withNamespaces props from Link component
Use 302 redirects instead of 301 and prevent caching for localeSubpaths

New features:

Add serverLanguageDetection config option
Add error page to example

0.18.2

Pass all props through Link component.

0.18.1

Revert 34e8e08 due to zeit/next.js#6026.

0.17.1

Two small bug fixes for dev experience.

0.17.0

Important functionality updates relating to fallback languages and browser detection. Added the lng-from-req util and test coverage. Added e2e test coverage of the example project.

0.16.0

Persist language subpath across requests (especially to root) with localeSubpaths enabled.

0.15.0

Added a new ignoreRoutes config option to allow greater control over language cookies. See #68 for more information.

0.14.3

Important bug fix: add asset regex to forceTrailingSlash middleware.

0.14.2

Remove contributors badge.

0.14.1

Ignore jest files.

0.14.0

Several bug fixes. Updated url parsing approach. Added test infrastructure and tests for most units/components.

0.13.0

Update i18next deps

0.12.2

Always send defaultNS down to client

0.12.1

Add initObject with other object keys to getInitialProps

0.12.0

Export Trans component bound to i18n instance.

0.11.2

Bug fix for config.ns in appWithTranslation HOC, and add console warning when namespacesRequired is undefined.

0.11.1

Update docs.

0.11.0

Remove tree-walking approach in favour of explicitly-declared namespaces. See #54 for discussion.

Will fallback to sending all namespaces down to client. New namespacesRequired setting added to main README.

0.10.3

Several small bug fixes:

Preserve querystring (2c3cb59)
Fix empty react-tree-walker context (22ec3cb)

0.10.2

Fix development-only tree walking bug related to 2386bf2.

This bug has something to do with react-i18next context, but is yet undiagnosed.

0.10.1

Several bug fixes, including:

Allowing 'as' prop in Link and fixing 'href' prop (#45)
Use url.parse to support query parms with localeSubpaths (cb10d37)

0.10.0

Implement tree-walking to determine namespace deps based on individual requests.

See #40.

0.9.0

Several important updates to improve the distinction between client and server source.

Use of i18next-browser-languagedetector is now optional via the config option browserLanguageDetection.

Breaking change: the middleware must now be imported from next-i18next/middleware, and is not returned via class initialisation. This is to prevent it being included in the client bundle.

0.8.0

Add support for i18next plugins via a use array on the config object.

0.7.0

Run getInitialProps on wrapped _app, and improve documentation.

0.6.0

Add hoistNonReactStatics

0.5.0

Reduce Node version requirement to >=8 to support deployment via now.

0.4.0

Add support for next export, and add bug fix for pageProps.

0.3.1

Move eslint-plugin-react to devDependencies.