feat: Add support for custom prefixes for i18n routing

[amannn]

Resolves #653

Information

The localePrefix option for createMiddleware as well as the navigation APIs now not only accepts a string, but an object where custom prefixes can be added per locale:

import {LocalePrefix} from 'next-intl/routing';

export const locales = ['en-US', 'de-AT', 'zh'] as const;

export const localePrefix = {
  mode: 'always',
  prefixes: {
    'en-US': '/us',
    'de-AT': '/eu/at'
    // (/zh will be used as-is)
  }
} satisfies LocalePrefix<typeof locales>;

In addition to this implementation, I've restructured the routing docs to discuss config options that are shared among the middleware and navigation APIs on a single page. We might expand on this in the future (see below).

See the docs.

Important: As mentioned in the docs, you might have to adjust your middleware matcher to handle the custom prefixes.

Changes

• Add support for custom prefixes for i18n routing
• Fix initial render when passing a relative href to Link (<Link href="about" />)
• Deprecate import {Pathnames} from 'next-intl/navigation' in favor of import {Pathnames} from 'next-intl/routing'

Potential future changes

I'm considering adding an API like const routing = defineRouting({locales: ['en', 'de'], ...}) to gather all routing-related config. This could be passed as createMiddleware({routing, ...}) (see #779).

(also resolves #940)

[vercel]

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	Jun 10, 2024 0:14am
next-intl-example-app-router	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 10, 2024 0:14am