Inicio rápido de React

Internacionaliza tu aplicación React en 5 minutos con gt-react

Resumen

Esta guía describe cómo internacionalizar un proyecto existente de React.

Cubriremos 4 pasos simples:

Instalación de las bibliotecas requeridas

Seleccionar idiomas

Agregar el componente <T>

Agregar tus variables de entorno

Todo este proceso debería tomar menos de 5 minutos.


Configuración

1. Instalar bibliotecas

Instala las bibliotecas gt-react y gtx-cli.

npm i gt-react
npm i gtx-cli --save-dev

2. Seleccionar idiomas

<GTProvider> se utiliza para configurar el comportamiento de gt-react. Debe colocarse lo más alto posible en tu aplicación, idealmente en la raíz.

Simplemente pasa una lista de códigos de locales para agregarlos a tu aplicación.

App.js
import { GTProvider } from "gt-react";
import MyApp from "./MyApp";
 
export default function App() {
  return (
    // Soporte para francés y chino
    <GTProvider locales={['fr', 'zh']}> 
      <MyApp />
    </GTProvider> 
  );
}

Para una lista completa de las props de <GTProvider> y documentación extendida, consulta la referencia de API.

3. Agregar el componente <T>

Envuelve cualquier contenido JSX anidado en el componente <T> para hacerlo traducible. Para más información, consulta la guía sobre el uso de componentes <T>.

Example.js
import { T } from "gt-react";
 
export default function Example() {
  return (
    <T>
      <p>
        Esto se traduce.
      </p>
    </T>  
  );
}

Usa el componente <Var> para designar contenido JSX que no debe traducirse.

Example.js
import { T, Var } from "gt-react";
 
export default function Example() {
  return (
    <T>
      <p>
        Esto se traduce. <Var>Esto no.</Var>
      </p>
    </T>  
  );
}

Consejo: Para ahorrar tiempo, ejecuta el comando de configuración. Esto escaneará tu base de código en busca de JSX traducible e insertará las etiquetas <T> por ti.

shell
npx gtx-cli setup

Para cadenas de texto, puedes usar useGT() para la traducción. Para más información, consulta esta guía.

Example.js
import { useGT } from "gt-react";
 
export default function Example() {
  const t = useGT(); 
  return (
    <p>
      {t("Esto se traduce.")}
    </p>
  );
}

4. Agrega tus variables de entorno

Agrega tu clave de API y el ID del proyecto a tus variables de entorno.

Navega al Panel de Control.

  • Navega a la página de Claves de Desarrollador en la barra lateral.

Haz clic en Crear Clave API de Desarrollo y luego copia la clave API y el ID del Proyecto a tu portapapeles.

Añade el ID del Proyecto y la Clave API a tus variables de entorno. Dependiendo de tu framework de React, las variables de entorno pueden verse ligeramente diferentes. Estas instrucciones son para ENTORNOS DE DESARROLLO ÚNICAMENTE.

VITE_GT_API_KEY="YOUR_GT_DEV_API_KEY"
VITE_GT_PROJECT_ID="YOUR_GT_PROJECT_ID"

¡Protege Tus Claves API!

Las variables de entorno de React a menudo se empaquetan en tu aplicación durante el tiempo de compilación y son visibles públicamente en el código del lado del cliente. Por razones de seguridad, deberías:

  • Usar solo claves API de desarrollo durante el desarrollo local
  • Usar solo claves API de producción con la herramienta CLI para el despliegue
  • Nunca incluir ninguna clave API como variable de entorno en producción

¡Vamos a probarlo!

¡Felicidades! 🥳 ¡Tu aplicación ahora es multilingüe! Veámosla en acción.

Ver tu aplicación en otro idioma

Agrega el componente <LocaleSelector> a tu aplicación. Esto te permitirá seleccionar un idioma diferente para tu aplicación.

Consejo: También puedes cambiar tu idioma en la configuración de tu navegador.

Inicia tu aplicación React en modo de desarrollo.

npm run dev 

Abre tu aplicación en tu navegador preferido (generalmente en http://localhost:3000).

Solución de problemas


Envío a Producción

Sigue nuestra guía sobre envío a producción.


Próximos pasos

  • Consulta nuestra referencia de API de React para obtener información detallada sobre el componente <T> y otros componentes disponibles.
  • Crea una lista de idiomas aprobados para tu aplicación con el plugin de React.

En esta página