Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: next-intl@4 #1412

Draft
wants to merge 36 commits into
base: main
Choose a base branch
from
Draft

feat!: next-intl@4 #1412

wants to merge 36 commits into from

Conversation

amannn
Copy link
Owner

@amannn amannn commented Oct 9, 2024

amannn and others added 20 commits June 20, 2024 16:08
This reverts commit 47239f9.
…currently active pathname for localized pathnames
# Conflicts:
#	packages/next-intl/src/middleware/utils.test.tsx
#	packages/next-intl/src/shared/utils.test.tsx
…is rendered from a Server Component (#1191)

This should ease the transition from Server to Client Components, as you
don't have to manually pass this prop anymore. If you've previously
passed this prop manually, you can remove this assignment now.

If this is not desired (e.g. because you have a large `formats` object
that you don't want to pass to the client side), you can manually
opt-out via `formats={{}}` on `NextIntlClientProvider` in order to not
provide any formats on the client side.

**BREAKING CHANGE:** There's a very rare chance where this can break
existing behavior. If you're rendering `NextIntlClientProvider` in a
Server Component, you rely on static rendering, but you're not using
`unstable_setRequestLocale` (i.e. you're using hooks like
`useTranslations` exclusively in Client Components), this can opt your
page into dynamic rendering. If this affects you, please provide the
`formats` prop explicitly to `NextIntlClientProvider`.
Copy link

vercel bot commented Oct 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
next-intl-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 1, 2024 8:59am
next-intl-example-app-router ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 1, 2024 8:59am
next-intl-example-app-router-without-i18n-routing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 1, 2024 8:59am

@amannn amannn changed the title next-intl@4 feat!: next-intl@4 Oct 9, 2024
@amannn amannn added v4 and removed v4 labels Oct 9, 2024
If you have nested providers, previously only the configuration of the
innermost one would be applied.

With this change, configuration is now passed from one provider to the
next, while allowing to override individual props.

**BREAKING CHANGE:** There's a very rare chance that this change affects
your app, but in case you've previously relied on providers not
inheriting from each other, you now have to reset props manually in case
you want to retain the prev. behavior.
# Conflicts:
#	packages/next-intl/.size-limit.ts
…arams` when rendered on the client side (#1483)

Bumps the Next.js peer dependency to 13.3.
…cessary and only disable cookie if `localeCookie: false` is set (#1487)

**Changes**
1. The `maxAge` attribute of the locale cookie is decreased from 1 year
to 5 hours in order to be GDPR-compliant.
2. The locale cookie is now only set when the user's language doesn't
match a requested locale. E.g. a user with `accept-language: 'en'` will
cause a cookie to be set when `/de` is requested to remember the
preference for `de`.
3. `localeDetection: false` previously ambiguously also disabled the
cookie from being set. This is no longer the case. For consistency, you
can now use the explicit [`localeCookie:
false`](https://next-intl-docs.vercel.app/docs/routing#locale-cookie)
option instead.

If you want to increase the cookie expiration, you can use the
[`maxAge`](https://next-intl-docs.vercel.app/docs/routing#locale-cookie)
attribute to do so:

```tsx
import {defineRouting} from 'next-intl/routing';
 
export const routing = defineRouting({
  // ...
 
  localeCookie: {
    // Expire in one year
    maxAge: 60 * 60 * 24 * 365
  }
});
```
…es` (#1489)

If consumers use type-safe `IntlMessages`, these will now be used for
`useMessages` and `getMessages`.

Fixes #1452
**Changes**
- Revamps the API to augment types by getting rid of the global
`IntlMessages` and `IntlFormats` in favor of a more general `AppConfig`
that is scoped to `next-intl`.
- Adds support for strictly-typing the locale across `useLocale` as well
as the navigation APIs.
- Adds `import {Locale} from 'next-intl';` as a convenience API to be
reused wherever a `locale` is passed around.
- Add `hasLocale(locales, candidate)` API for simplified checking of
whether a locale is available with TypeScript.
- Adds a new `import {Messages} from 'next-intl;` type that corresponds
to the `Messages` you've provided in `AppConfig` (probably rarely
needed).


**Example:**

```tsx
// global.d.ts

import {routing} from '@/i18n/routing';
import {formats} from '@/i18n/request';
import en from './messages/en.json';

declare module 'next-intl' {
  interface AppConfig {
    Locale: (typeof routing.locales)[number];
    Formats: typeof formats;
    Messages: typeof en;
  }
}
```

**→ [Proposed
docs](https://next-intl-docs-git-feat-augmented-config-next-intl.vercel.app/docs/workflows/typescript)**

Fixes #1377
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant