Middleware

createNextMiddleware

Référence de l’API pour la méthode createNextMiddleware().

Vue d’ensemble

createNextMiddleware est une fonction utilitaire qui crée un middleware à utiliser avec Next.js. Elle permet d’ajouter une route distincte pour chaque locale dans votre application Next.js.

Par exemple, un utilisateur français sera dirigé vers /fr/landing et un utilisateur anglais vers /en/landing.

Pour en savoir plus sur l’utilisation de ce middleware, consultez le guide de routage i18n.

Références

Props

Prop

Type

Description

PropriétéDescription
pathConfigUn objet imbriqué qui définit les chemins localisés de votre application.
localeRoutingUn indicateur pour activer ou désactiver le routage i18n.
prefixDefaultLocaleUn indicateur pour activer ou désactiver la suppression du préfixe de locale pour la locale par défaut (p. ex. /en/about/about).

Exemple

Utilisation de base

Il suffit d’appeler cette fonction et d’ajouter le comparateur de chemin dans votre fichier middleware pour activer le routage par locale.

middleware.js
import { createNextMiddleware } from 'gt-next/middleware'

export default createNextMiddleware();

export const config = {
  matcher: [
    /*
      * Correspond à tous les chemins de requête sauf ceux qui commencent par :
      * - api (routes API)
      * - _next (fichiers internes)
      * - fichiers statiques
      */
    "/((?!api|static|.*\\..*|_next).*)",
  ],
}

Chemins localisés

Vous pouvez définir des chemins localisés via l’option pathConfig dans le fichier de middleware.

middleware.js
export default createNextMiddleware({
  pathConfig: {
    "/about": "/about",
    "/airplanes": {
      "zh": "/飞机",
    }
  },
});

Consultez le guide de routage i18n pour une explication détaillée de son fonctionnement.

Supprimer le préfixe de la locale par défaut

Vous pouvez supprimer le préfixe de la locale par défaut en réglant l’option prefixDefaultLocale sur false.

middleware.js
export default createNextMiddleware({
  prefixDefaultLocale: true,
});

Lorsque cette option est à true, chaque chemin doit être précédé de la locale. Si vous la définissez sur false (valeur par défaut), seule la locale par défaut sera omise du chemin.


Notes

  • La fonction createNextMiddleware est une fonction utilitaire qui crée un middleware à utiliser avec Next.js.

Étapes suivantes

Que pensez-vous de ce guide ?

createNextMiddleware