Traduce tu React Router v7 (File-System Routes) con Intlayer | Internacionalización (i18n)

Esta guía demuestra cómo integrar Intlayer para una internacionalización fluida en proyectos con React Router v7 usando enrutamiento basado en el sistema de archivos (@react-router/fs-routes) con enrutamiento consciente del locale, soporte para TypeScript y prácticas modernas de desarrollo.

Table of Contents

¿Qué es Intlayer?

Intlayer es una biblioteca innovadora y de código abierto para internacionalización (i18n) diseñada para simplificar el soporte multilingüe en aplicaciones web modernas.

Con Intlayer, puedes:

• Gestionar traducciones fácilmente usando diccionarios declarativos a nivel de componente.
• Localizar dinámicamente metadatos, rutas y contenido.
• Garantizar soporte para TypeScript con tipos autogenerados, mejorando la autocompletación y la detección de errores.
• Beneficiarte de características avanzadas, como la detección y cambio dinámico de locale.
• Habilitar enrutamiento consciente del locale con el sistema de enrutamiento basado en el sistema de archivos de React Router v7.

Guía paso a paso para configurar Intlayer en una aplicación React Router v7 con rutas basadas en el sistema de archivos

See Application Template on GitHub.

Paso 1: Instalar dependencias

Instala los paquetes necesarios usando tu gestor de paquetes preferido:

npm install intlayer react-intlayernpm install vite-intlayer --save-devnpm install @react-router/fs-routes --save-dev

• intlayer

• intlayer

  El paquete principal que proporciona herramientas de internacionalización para la gestión de configuración, traducción, declaración de contenido, transpile y comandos CLI.

• react-intlayer El paquete que integra Intlayer con la aplicación React. Proporciona proveedores de contexto y hooks para la internacionalización en React.

• vite-intlayer Incluye el plugin de Vite para integrar Intlayer con el empaquetador Vite, así como middleware para detectar el locale preferido del usuario, gestionar cookies y manejar la redirección de URLs.

• @react-router/fs-routes El paquete que habilita el enrutamiento basado en el sistema de archivos para React Router v7.

Paso 2: Configuración de tu proyecto

Crea un archivo de configuración para configurar los idiomas de tu aplicación:

import { type IntlayerConfig, Locales } from "intlayer";const config: IntlayerConfig = {  internationalization: {    defaultLocale: Locales.ENGLISH,    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],  },};export default config;

A través de este archivo de configuración, puedes configurar URLs localizadas, redirección mediante middleware, nombres de cookies, la ubicación y extensión de tus declaraciones de contenido, deshabilitar los registros de Intlayer en la consola, y más. Para una lista completa de los parámetros disponibles, consulta la documentación de configuración.

Paso 3: Integra Intlayer en tu configuración de Vite

Agrega el plugin intlayer en tu configuración:

import { reactRouter } from "@react-router/dev/vite";import { defineConfig } from "vite";import { intlayer } from "vite-intlayer";import tsconfigPaths from "vite-tsconfig-paths";export default defineConfig({  plugins: [reactRouter(), tsconfigPaths(), intlayer()],});

El plugin intlayer() para Vite se utiliza para integrar Intlayer con Vite. Asegura la construcción de archivos de declaración de contenido y los supervisa en modo desarrollo. Define variables de entorno de Intlayer dentro de la aplicación Vite. Además, proporciona alias para optimizar el rendimiento.

Paso 4: Configurar las rutas basadas en el sistema de archivos de React Router v7

Configura tu enrutamiento para usar rutas basadas en el sistema de archivos con flatRoutes:

import type { RouteConfig } from "@react-router/dev/routes";import { flatRoutes } from "@react-router/fs-routes";import { configuration } from "intlayer";const routes: RouteConfig = flatRoutes({  // Ignorar los archivos de declaración de contenido para que no se traten como rutas  ignoredRouteFiles: configuration.content.fileExtensions.map(    (fileExtension) => `**/*${fileExtension}`  ),});export default routes;

La función flatRoutes de @react-router/fs-routes habilita el enrutamiento basado en el sistema de archivos, donde la estructura de archivos en el directorio routes/ determina las rutas de tu aplicación. La opción ignoredRouteFiles garantiza que los archivos de declaración de contenido de Intlayer (.content.ts, etc.) no se traten como archivos de ruta.

Paso 5: Crear archivos de ruta con convenciones del sistema de archivos

Con el enrutamiento basado en el sistema de archivos, usas una convención de nomenclatura plana donde los puntos (.) representan segmentos de ruta y los paréntesis () denotan segmentos opcionales.

Crea los siguientes archivos en tu directorio app/routes/:

Estructura de archivos

app/routes/├── ($locale)._layout.tsx        # Wrapper de layout para rutas de locale├── ($locale)._index.tsx         # Página de inicio (/:locale?)├── ($locale)._index.content.ts  # Contenido de la página de inicio├── ($locale).about.tsx          # Página Acerca de (/:locale?/about)└── ($locale).about.content.ts   # Contenido de la página Acerca de

Las convenciones de nomenclatura:

• ($locale) - Segmento dinámico opcional para el parámetro de locale
• _layout - Ruta de layout que envuelve las rutas hijas
• _index - Ruta de índice (se renderiza en la ruta padre)
• . (punto) - Separa segmentos de ruta (por ejemplo, ($locale).about → /:locale?/about)

Componente de Layout

import { IntlayerProvider } from "react-intlayer";import { Outlet } from "react-router";import { useI18nHTMLAttributes } from "~/hooks/useI18nHTMLAttributes";import type { Route } from "./+types/($locale)._layout";export default function RootLayout({ params }: Route.ComponentProps) {  useI18nHTMLAttributes();  const { locale } = params;  return (    <IntlayerProvider locale={locale}>      <Outlet />    </IntlayerProvider>  );}

Página de índice

import { useIntlayer } from "react-intlayer";import { LocalizedLink } from "~/components/localized-link";import type { Route } from "./+types/($locale)._index";export default function Page() {  const { title, description, aboutLink } = useIntlayer("page");  return (    <div>      <h1>{title}</h1>      <p>{description}</p>      <nav>        <LocalizedLink to="/about">{aboutLink}</LocalizedLink>      </nav>    </div>  );}

Página Acerca de

import { useIntlayer } from "react-intlayer";import { LocalizedLink } from "~/components/localized-link";import type { Route } from "./+types/($locale).about";export default function AboutPage() {  const { title, content, homeLink } = useIntlayer("about");  return (    <div>      <h1>{title}</h1>      <p>{content}</p>      <nav>        <LocalizedLink to="/">{homeLink}</LocalizedLink>      </nav>    </div>  );}

Paso 6: Declara Tu Contenido

Crea y gestiona tus declaraciones de contenido para almacenar traducciones. Coloca los archivos de contenido junto a tus archivos de ruta:

import { t, type Dictionary } from "intlayer";const pageContent = {  key: "page",  content: {    title: t({      en: "Welcome to React Router v7 + Intlayer",      es: "Bienvenido a React Router v7 + Intlayer",      fr: "Bienvenue sur React Router v7 + Intlayer",    }),    description: t({      en: "Build multilingual applications with ease using React Router v7 and Intlayer.",      es: "Cree aplicaciones multilingües fácilmente usando React Router v7 y Intlayer.",      fr: "Créez des applications multilingues facilement avec React Router v7 et Intlayer.",    }),    aboutLink: t({      en: "Learn About Us",      es: "Aprender Sobre Nosotros",      fr: "En savoir plus sur nous",    }),  },} satisfies Dictionary;export default pageContent;

import { t, type Dictionary } from "intlayer";const aboutContent = {  key: "about",  content: {    title: t({      en: "About Us",      es: "Sobre Nosotros",      fr: "À propos de nous",    }),    content: t({      en: "This is the about page content.",      es: "Este es el contenido de la página de información.",      fr: "Ceci est le contenu de la page à propos.",    }),    homeLink: t({      en: "Home",      es: "Inicio",      fr: "Accueil",    }),  },} satisfies Dictionary;export default aboutContent;

Tus declaraciones de contenido pueden definirse en cualquier parte de tu aplicación tan pronto como se incluyan en el directorio contentDir (por defecto, ./app). Y deben coincidir con la extensión del archivo de declaración de contenido (por defecto, .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}).

Para más detalles, consulta la documentación de declaración de contenido.

Paso 7: Crear Componentes Sensibles al Idioma

Crea un componente LocalizedLink para la navegación sensible al idioma:

import type { FC } from "react";import { getLocalizedUrl, type LocalesValues } from "intlayer";import { useLocale } from "react-intlayer";import { Link, type LinkProps, type To } from "react-router";const isExternalLink = (to: string) => /^(https?:)?\/\//.test(to);// Función para localizar la URL según el localeexport const locacalizeTo = (to: To, locale: LocalesValues): To => {  if (typeof to === "string") {    if (isExternalLink(to)) {      return to;    }    return getLocalizedUrl(to, locale);  }  if (isExternalLink(to.pathname ?? "")) {    return to;  }  return {    ...to,    pathname: getLocalizedUrl(to.pathname ?? "", locale),  };};// Componente para enlaces localizadosexport const LocalizedLink: FC<LinkProps> = (props) => {  const { locale } = useLocale();  return <Link {...props} to={locacalizeTo(props.to, locale)} />;};

En caso de que desees navegar a las rutas localizadas, puedes usar el hook useLocalizedNavigate:

import { useLocale } from "react-intlayer";import { type NavigateOptions, type To, useNavigate } from "react-router";import { locacalizeTo } from "~/components/localized-link";export const useLocalizedNavigate = () => {  const navigate = useNavigate();  const { locale } = useLocale();  const localizedNavigate = (to: To, options?: NavigateOptions) => {    const localedTo = locacalizeTo(to, locale);    navigate(localedTo, options);  };  return localizedNavigate;};

Paso 8: Crear un componente para cambiar de idioma

Crea un componente para permitir a los usuarios cambiar de idioma:

import type { FC } from "react";import {  getHTMLTextDir,  getLocaleName,  getLocalizedUrl,  getPathWithoutLocale,  Locales,} from "intlayer";import { useIntlayer, useLocale } from "react-intlayer";import { Link, useLocation } from "react-router";export const LocaleSwitcher: FC = () => {  const { localeSwitcherLabel } = useIntlayer("locale-switcher");  const { pathname } = useLocation();  const { availableLocales, locale } = useLocale();  const pathWithoutLocale = getPathWithoutLocale(pathname);  return (    <ol>      {availableLocales.map((localeItem) => (        <li key={localeItem}>          <Link            aria-current={localeItem === locale ? "page" : undefined}            aria-label={`${localeSwitcherLabel.value} ${getLocaleName(localeItem)}`}            reloadDocument // Recargar la página para aplicar la nueva locale            to={getLocalizedUrl(pathWithoutLocale, localeItem)}          >            <span>              {/* Localización - p.ej. FR */}              {localeItem}            </span>            <span>              {/* Idioma en su propia localización - p.ej. Français */}              {getLocaleName(localeItem, locale)}            </span>            <span dir={getHTMLTextDir(localeItem)} lang={localeItem}>              {/* Idioma en la localización actual - p.ej. Francés con la localización actual configurada a Locales.SPANISH */}              {getLocaleName(localeItem)}            </span>            <span dir="ltr" lang={Locales.ENGLISH}>              {/* Idioma en inglés - por ejemplo, French */}              {getLocaleName(localeItem, Locales.ENGLISH)}            </span>          </Link>        </li>      ))}    </ol>  );};

Para aprender más sobre el hook useLocale, consulta la documentación.

Paso 9: Añadir gestión de atributos HTML (Opcional)

Crea un hook para gestionar los atributos lang y dir del HTML:

import { getHTMLTextDir } from "intlayer";import { useEffect } from "react";import { useLocale } from "react-intlayer";export const useI18nHTMLAttributes = () => {  const { locale } = useLocale();  useEffect(() => {    document.documentElement.lang = locale;    document.documentElement.dir = getHTMLTextDir(locale);  }, [locale]);};

Este hook ya se usa en el componente de layout (($locale)._layout.tsx) mostrado en el Paso 5.

Paso 10: Añadir middleware (Opcional)

También puedes usar el intlayerProxy para agregar enrutamiento del lado del servidor a tu aplicación. Este plugin detectará automáticamente la configuración regional actual basada en la URL y establecerá la cookie de configuración regional apropiada. Si no se especifica ninguna configuración regional, el plugin determinará la configuración regional más adecuada según las preferencias de idioma del navegador del usuario. Si no se detecta ninguna configuración regional, redirigirá a la configuración regional predeterminada.

Ten en cuenta que para usar el intlayerProxy en producción, necesitas cambiar el paquete vite-intlayer de devDependencies a dependencies.

import { reactRouter } from "@react-router/dev/vite";import { defineConfig } from "vite";import { intlayer, intlayerProxy } from "vite-intlayer";import tsconfigPaths from "vite-tsconfig-paths";export default defineConfig({  plugins: [reactRouter(), tsconfigPaths(), intlayer(), intlayerProxy()],});

Configurar TypeScript

Intlayer utiliza la ampliación de módulos para aprovechar las ventajas de TypeScript y fortalecer tu base de código.

Asegúrate de que tu configuración de TypeScript incluya los tipos autogenerados:

{  // ... tus configuraciones existentes  include: [    // ... tus inclusiones existentes    ".intlayer/**/*.ts", // Incluir los tipos autogenerados  ],}

Configuración de Git

Se recomienda ignorar los archivos generados por Intlayer. Esto te permite evitar comprometerlos en tu repositorio Git.

Para hacer esto, puedes agregar las siguientes instrucciones a tu archivo .gitignore:

# Ignorar los archivos generados por Intlayer.intlayer

Extensión de VS Code

Para mejorar tu experiencia de desarrollo con Intlayer, puedes instalar la Extensión oficial de Intlayer para VS Code.

Instalar desde el Marketplace de VS Code

Esta extensión ofrece:

• Autocompletado para las claves de traducción.
• Detección de errores en tiempo real para traducciones faltantes.
• Previsualizaciones en línea del contenido traducido.
• Acciones rápidas para crear y actualizar traducciones fácilmente.

Para más detalles sobre cómo usar la extensión, consulta la documentación de la Extensión de Intlayer para VS Code.

Ir Más Allá

Para profundizar, puedes implementar el editor visual o externalizar tu contenido usando el CMS.

Referencias de la Documentación

• Documentación de Intlayer
• Documentación de React Router v7
• Documentación React Router fs-routes
• Hook useIntlayer
• Hook useLocale
• Declaración de Contenido
• Configuración

Esta guía completa proporciona todo lo que necesitas para integrar Intlayer con React Router v7 usando enrutamiento basado en el sistema de archivos para una aplicación completamente internacionalizada con enrutamiento consciente del idioma y soporte para TypeScript.