CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.9.0 (2024-02-20)

Features

• Add redirects for case mismatches in locale prefixes (e.g. /EN → /en) (#861 by @fkapsahili) (3b2b446)

3.8.0 (2024-02-19)

Features

• Add format.dateTimeRange (#769 by @martinmunillas) (9f12521)

3.7.0 (2024-02-09)

Features

• Add support for permanentRedirectin navigation APIs (#850 by @polvallverdu) (6508ddc)

3.6.0 (2024-02-08)

Features

• Support formatting of React elements via format.list(…). (#845) (7bf11d4)

3.5.4 (2024-02-01)

Bug Fixes

• Keep cookie value in sync when navigating within a locale (#828) (1167523), closes #826

3.5.3 (2024-01-29)

Bug Fixes

• Improve RSC render performance by sharing a cache between getTranslations and useTranslations (#798 by @fkapsahili) (73e8337)

3.5.2 (2024-01-25)

Bug Fixes

• Set cookie to SameSite: Lax (#817) (0e91e64), closes #527 #811

3.5.1 (2024-01-23)

Bug Fixes

• Remove x-default alternate links entry for non-root pathnames when using localePrefix: 'always' (#805) (c5bb0f5)

3.5.0 (2024-01-22)

Features

• Make options for createSharedPathnamesNavigation along with locales argument optional (relevant when locales aren't known statically) (#784) (614053d)

3.4.5 (2024-01-19)

Bug Fixes

• Make sure cookie value stays up to date when the Next.js Router Cache is used (#790) (977b973), closes #786 #786

3.4.4 (2024-01-17)

Bug Fixes

• Improve error message for missing messages by including the locale (#782) (79eee9d)

3.4.3 (2024-01-16)

Bug Fixes

• Apply global timeZone when using date skeletons in messages (e.g. Ordered on {orderDate, date, ::yyyyMd}) (#695) (8940192), closes #693

3.4.2 (2024-01-09)

Bug Fixes

• Change numeric option from auto to always for format.relativeTime (#765) (246d373), closes #757

3.4.1 (2024-01-03)

Bug Fixes

• Fix ESM output of use-intl (#754) (e73fb38)

3.4.0 (2023-12-21)

Features

• Invoke notFound() when no locale was attached to the request and update docs to suggest validating the locale in i18n.ts (#742) (e6d9878), closes #736 #716 /next-intl-docs.vercel.app/docs/usage/configuration#i18

3.3.3 (2023-12-20)

Bug Fixes

• Improve performance when calling hooks like useTranslations in Server Components by making sure we only suspend when i18n config is initially loaded and never for subsequent calls (#741) (4185a72)

3.3.2 (2023-12-11)

Bug Fixes

• Fix types for passing a custom type to redirect (#714) (db65cb7), closes #709

3.3.1 (2023-12-07)

Bug Fixes

• Improve error message when encountering a missing message in production (#706) (515891b)

3.3.0 (2023-12-06)

Features

• Add support for basePath in middleware and navigation APIs (#699 by @Robjam and @amannn) (f670f1b)

3.2.5 (2023-12-06)

Bug Fixes

• Correctly normalize pathname for redirects and alternate links when localePrefix: 'as-needed' is used with the default locale (#698 by @anna-colenso) (48e9523)

3.2.4 (2023-12-05)

Bug Fixes

• Fix compatibility with moduleResolution: 'Bundler' (#694) (f7425a5), closes #690

3.2.3 (2023-12-05)

Bug Fixes

• Prefer locale from NextIntlClientProvider when using useLocale in Client Components. useParams().locale is still used as a fallback. (#691) (e00ed97), closes #688

3.2.2 (2023-12-04)

Bug Fixes

• Allow to call getRequestConfig in outer module closure in a Client Component module graph (#687) (0f16f10), closes #685

3.2.1 (2023-12-01)

Bug Fixes

• Allow to import next-intl/server into Client Components (however not call any functions). This allows for easier testing of page components with multiple exports. (#683) (5ca4075), closes #681

3.2.0 (2023-11-29)

Features

• Add localePrefix for navigation APIs for an improved initial render of Link when using localePrefix: never. Also fix edge case in middleware when using localized pathnames for redirects that remove a locale prefix (fixes an infinite loop). (#678) (1c68e3b), closes #444

3.1.4 (2023-11-24)

Bug Fixes

• Apply correct port and protocol during domain-based redirects when called from an internal address (e.g. from a proxy) (#662) (2bb867d), closes #658

3.1.3 (2023-11-22)

Bug Fixes

• Don't set cookie on response if localeDetection: false (#654) (e85149c), closes #609

3.1.2 (2023-11-20)

Bug Fixes

• Update link to migration example in error messages (#648 by @outloudvi) (1f3b226)

3.1.1 (2023-11-20)

Note: Version bump only for package root

3.1.0 (2023-11-17)

Features

• Experimental support for --turbo (requires next@^14.0.3) (#641) (46c6ec7), closes #250

3.0.3 (2023-11-15)

Bug Fixes

• Don't retrieve defaults for locale, now and timeZone if these options have been provided to NextIntlClientProvider (#633) (824363a), closes #631

3.0.2 (2023-11-15)

Bug Fixes

• Allow usage of getTranslations({namespace}) without TypeScript integration for messages (#630) (62cf29c), closes #625

3.0.1 (2023-11-14)

Add provenance statement to published packages.

3.0.0 (2023-11-14)

Please refer to the release notes.

2.22.1 (2023-11-02)

Bug Fixes

• Correct version range (ffbff8e)

2.22.0 (2023-11-02)

Features

• Support Next.js 14 (#593) (5c449f5)

2.21.0 (2023-10-18)

Features

• Support custom units in format.relativeTime (#566) (6e1bc35)

2.20.2 (2023-09-22)

Bug Fixes

• Add error reporting when no timeZone is specified and downgrade error handling for missing now value from throwing to reporting an error (#519) (dc55ab2)

2.20.1 (2023-09-21)

Bug Fixes

• Use correct port for alternate links when running behind a proxy (#514 by @iza-w) (747ad5b)

2.20.0 (2023-08-23)

Features

• Improve runtime performance of useTranslations by avoiding the creation of message format instances if possible and introducing a cross-component message format cache (#475) (4d177f8), closes #294

2.19.4 (2023-08-23)

Bug Fixes

• Allow to import next-intl/link into Server Components without having to add a wrapping Client Component (#465) (21a0691)

2.19.3 (2023-08-23)

Bug Fixes

• Apply time zone for built-in default formats (full, long, medium, short) (#473) (244b9b2), closes #467

2.19.2 (2023-08-22)

Bug Fixes

• Use correct host and protocol for alternate links when running behind a proxy (x-forwarded-host, x-forwarded-proto) (#462 by @HHongSeungWoo) (747cf8e)

2.19.1 (2023-08-01)

Bug Fixes

• Handle case where the locale param is an array and set cookie expiration to one year (#435) (82e842c)

2.19.0 (2023-07-18)

Features

• Add localePrefix: 'never' option for middleware (#388 by @boris-arkenaar) (92ec33a), closes #366

2.18.0 (2023-07-17)

Features

• Accept locale with useRouter APIs (#409) (0fbb3c7), closes #408 #407 #320

2.17.5 (2023-07-07)

Bug Fixes

• Use ESM build only for browser bundlers (not Node.js) (#386) (34a69f2)

2.17.4 (2023-07-05)

Bug Fixes

• Bring back ESM build (and fix bundle size) (#381) (4d0fefc)

2.17.3 (2023-07-05)

Bug Fixes

• Forward optional remaining args from Next.js router to wrapped useRouter (3ff878c)

2.17.2 (2023-07-05)

Bug Fixes

• Remove ESM build (#379) (22d9f27)

2.17.1 (2023-07-04)

Bug Fixes

• Switch to tsup for more efficient bundling and also switch to vitest internally (#375) (bf31626)

2.17.0 (2023-06-29)

Features

• Add autocomplete support for timeZone (#359 by @A7med3bdulBaset) (630dfc2)

2.16.0 (2023-06-29)

Features

• Add useMessages for convenience and restructure docs to be App Router-first (#345) (0dedbfd)

2.15.1 (2023-06-21)

Bug Fixes

• Allow usage of next-intl/link and usePathname outside of Next.js (#338) (6e1a56c), closes #337

2.15.0 (2023-06-20)

Features

• Add format.list(…) for formatting conjunctions and disjunctions (#327 by @stefanprobst) (32cda32)

2.14.6 (2023-05-22)

Note: Version bump only for package root

2.14.5 (2023-05-22)

Bug Fixes

• Set SameSite attribute for locale cookie to strict (#302) (0a6bce5), closes #301

2.14.4 (2023-05-22)

Bug Fixes

• Move JSDoc for next/link (b85b6f5)

2.14.3 (2023-05-22)

Bug Fixes

• Accept ref for next-intl/link (#300) (4d7cc17), closes #299

2.14.2 (2023-05-12)

Bug Fixes

• Fix forwarding of request headers in middleware (#269 by @ARochniak) (4ecbab5), closes #266

2.14.1 (2023-05-11)

Bug Fixes

• Fix support for older Next.js versions by moving Link to next-intl/link (#288) (f26ef99), closes #287

2.14.0 (2023-05-10)

Features

• Add navigation APIs for App Router (useRouter, usePathname and Link) (#282) (e30a89b)

2.13.4 (2023-05-05)

Note: Version bump only for package root

2.13.3 (2023-05-05)

Note: Version bump only for package root

2.13.2 (2023-05-03)

Bug Fixes

• Improve warning for invalid namespace characters (7435335)

2.13.1 (2023-04-14)

Bug Fixes

• Improve error message when trying to render an array as a message (#244) (c6a4f7a)

2.13.0 (2023-04-12)

Features

• Sync improvements from RSC branch to main (#238) (1d12ba2), closes #149 #237

2.12.0 (2023-03-25)

Features

• Add BigInt support for useFormatter.format() by @tacomanator (#222) (a5ded6c)

2.11.0 (2023-03-06)

Features

• Add useFormatter (replaces useIntl) (#209) (021b682)

2.10.4 (2023-02-20)

Bug Fixes

• Return up-to-date translations when messages change (#199) (78f39b4)

2.10.3 (2023-02-19)

Note: Version bump only for package root

2.10.2 (2022-12-09)

Bug Fixes

• Remove magic __DEV__ global (#151) (7d5aa6a)

2.10.1 (2022-12-09)

Note: Version bump only for package root

2.10.0 (2022-12-09)

Features

• Add support for using next-intl in the app folder with Next.js 13 (see https://next-intl-docs.vercel.app/docs/next-13, #144) (18c94d6)

2.9.2 (2022-12-08)

Note: Version bump only for package root

2.9.1 (2022-11-03)

Note: Version bump only for package root

2.9.0 (2022-10-27)

Features

• Next.js 13 compatibility (#140) (65326a0), closes #139

2.8.0 (2022-10-18)

Features

• Provide createTranslator and createIntl by extracting a React-agnostic core library. Thanks to David Brands from Marvia for sponsoring the work on this feature, participating in discussion and providing feedback! (#137) (91f7489)

2.7.6 (2022-09-22)

Note: Version bump only for package root

2.7.5 (2022-08-30)

Note: Version bump only for package root

2.7.4 (2022-05-30)

Bug Fixes

• Adapt TypeScript validation to work with messages files that only have a single top-level namespace (#115) (cf0b83e)

2.7.3 (2022-05-20)

Bug Fixes

• Add back the ability to render the provider without messages (#113) (8395822)

2.7.2 (2022-05-10)

Bug Fixes

• Enable tree-shaking (#108) (157b0e2)

2.7.1 (2022-04-28)

Bug Fixes

• Allow null message values (#110) (14ae8ff)

2.7.0 (2022-04-28)

Features

• Warn for invalid namespace keys (#106) (e86ab28)

2.6.0 (2022-04-08)

Features

• Support React 18 (#98) (38614eb)

2.5.0 (2022-04-01)

Features

• Type safe messages (#93) (13b49b1)

2.4.1 (2022-03-24)

Bug Fixes

• Overwrite prerelease (6caf5c4)

2.4.0 (2022-02-08)

Features

• Default translation values (#86) (0ed5e70)

2.3.5 (2022-01-19)

Bug Fixes

• Support identical wrappers with identical text content in rich text (#80) (b35bb9f)

2.3.4 (2022-01-04)

Bug Fixes

• Allow usage outside of Next.js (e.g. Jest and Storybook) (#76) (7c6925b)

2.3.3 (2021-12-23)

Note: Version bump only for package root

2.3.2 (2021-12-23)

Note: Version bump only for package root

2.3.1 (2021-12-23)

Note: Version bump only for package root

2.3.0 (2021-11-24)

Features

• Add useLocale and useTimeZone (#67) (7833f4a)

2.2.1 (2021-11-23)

Bug Fixes

• Clearer error message when no messages are provided (#66) (742729a)

2.2.0 (2021-11-02)

Features

• TypeScript improvements: Use enum type for style of NumberFormatOptions, only allow passing React children to messages rendered with t.rich and update tslib (#63) (d73e935)

2.1.1 (2021-10-28)

Note: Version bump only for package root

2.1.0 (2021-10-27)

Features

• Support Next.js 12 (#61) (0391cc8)

2.0.5 (2021-09-28)

Note: Version bump only for package root

2.0.4 (2021-09-28)

Note: Version bump only for package root

2.0.3 (2021-09-17)

Note: Version bump only for package root

2.0.2 (2021-09-17)

Bug Fixes

• Render correct messages when the namespace changes in useTranslations (#58) (b8f7dab)

2.0.1 (2021-09-04)

Note: Version bump only for package root

2.0.0 (2021-08-26)

• feat!: Use a separate API for rich text formatting to avoid type casting in TypeScript #54 (4c13a64), closes #54

BREAKING CHANGES

• Instead of using the t function for formatting both regular messages and rich text, this function will only work for regular messages now. For rich text you can use t.rich instead now.

1.5.1 (2021-08-13)

Bug Fixes

• Improve API for rendering raw messages and add docs (#51) (19f4a7e)

1.5.0 (2021-08-10)

Features

• Add flag to return raw messages (#48) (b34e19f)

1.4.7 (2021-08-02)

Bug Fixes

• Adjust default for onError of the provider to log errors correctly (#46) (d0a1986)

1.4.6 (2021-08-02)

Bug Fixes

• Use timeZone in translation function from useTranslations (#45) (ebf75f2)

1.4.5 (2021-07-26)

Note: Version bump only for package root

1.4.4 (2021-07-08)

Note: Version bump only for package root

1.4.3 (2021-07-08)

Note: Version bump only for package root

1.4.2 (2021-06-16)

Bug Fixes

• Don't require react-dom as a peer dependency (#39) (39edfcd)

1.4.1 (2021-06-16)

Bug Fixes

• Use correct version range for use-intl (02c33d3)

1.4.0 (2021-06-16)

Features

• Support Next.js 11 (#36) (fc59871)

1.3.11 (2021-05-07)

Note: Version bump only for package root

1.3.10 (2021-05-02)

Note: Version bump only for package root

1.3.9 (2021-05-02)

Note: Version bump only for package root

1.3.8 (2021-03-26)

Note: Version bump only for package root

1.3.7 (2021-02-12)

Note: Version bump only for package root

1.3.6 (2021-02-09)

Note: Version bump only for package root

1.3.5 (2021-02-09)

Note: Version bump only for package root

1.3.4 (2021-02-09)

Note: Version bump only for package root

1.3.3 (2021-02-09)

Bug Fixes

• Update DateTimeFormatOptions (#29) (91a8f52)

1.3.2

• Fix: Limit the function signature to return strings or React elements

1.3.1

• Fix: Apply interval correctly in useNow({updateInterval: …})

1.3.0

• Feat: Add a global fallback for the now parameter of formatRelativeTime.
• Feat: Add useNow hook, which can be used in conjunction with formatRelativeTime to continuously update the result.
• Fix: Allow messages to be optional on the provider.

1.2.0

• Feat: Added specific types for DateTimeFormatOptions.

1.1.0

• Feat: Added support for handling time zones.

1.0.1

• Fix: Use 1.0 version of use-intl.

1.0.0

This library is now considered production ready. There are no changes from the previous version.

0.4.0

• Feature: Add global formats (see docs)

0.3.2

• Fix: Export IntlErrorCode for JavaScript users.

0.3.1

• Fix: Return a stable function reference for t.

0.3.0

• Feature: Add error handling capabilities (see docs)

0.2.0

• Chore: Depend on use-intl
• BREAKING CHANGE: Rename NextIntlMessages to IntlMessages (TypeScript only)

0.1.1

• Fix: Don't throw for empty messages ("").