Começando a Internacionalização (i18n) com Intlayer e React Create App

    O que é o Intlayer?

    Intlayer é uma biblioteca inovadora e de código aberto de internacionalização (i18n) projetada para simplificar o suporte multilíngue em aplicações web modernas.

    Com o Intlayer, você pode:

    • Gerenciar traduções facilmente usando dicionários declarativos no nível do componente.
    • Localizar dinamicamente metadados, rotas e conteúdo.
    • Garantir suporte a TypeScript com tipos gerados automaticamente, melhorando a autocompletação e a detecção de erros.
    • Beneficiar-se de recursos avançados, como detecção e troca dinâmica de localidade.

    Guia Passo a Passo para Configurar o Intlayer em uma Aplicação React

    Passo 1: Instalar Dependências

    Instale os pacotes necessários usando npm:

    bash
    npm install intlayer react-intlayer react-scripts-intlayer
    • intlayer

      O pacote principal que fornece ferramentas de internacionalização para gerenciamento de configuração, tradução, declaração de conteúdo, transpiração e comandos do CLI.

    • react-intlayer

      O pacote que integra o Intlayer com a aplicação React. Fornece provedores de contexto e ganchos para a internacionalização em React. Além disso, inclui o plugin para integrar o Intlayer com a aplicação baseada no Create React App.

    Passo 2: Configuração do seu projeto

    Crie um arquivo de configuração para configurar os idiomas da sua aplicação:

    intlayer.config.ts
    import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [      Locales.ENGLISH,      Locales.FRENCH,      Locales.SPANISH,      // Suas outras localizações    ],    defaultLocale: Locales.ENGLISH,  },};export default config;

    Através deste arquivo de configuração, você pode configurar URLs localizadas, redirecionamento de middleware, nomes de cookies, a localização e a extensão das suas declarações de conteúdo, desativar logs do Intlayer no console, e mais. Para uma lista completa de parâmetros disponíveis, consulte a documentação de configuração.

    Passo 3: Integrar o Intlayer na Sua Configuração CRA

    Altere seus scripts para usar o react-intlayer

    package.json
      "scripts": {    "build": "react-scripts-intlayer build",    "start": "react-scripts-intlayer start",    "transpile": "intlayer build"  },

    Os scripts react-scripts-intlayer são baseados no craco. Você também pode implementar sua própria configuração com base no plugin craco do intlayer. Veja um exemplo aqui.

    Passo 4: Declarar Seu Conteúdo

    Crie e gerencie suas declarações de conteúdo para armazenar traduções:

    src/app.content.tsx
    import { t, type DeclarationContent } from "intlayer";import React, { type ReactNode } from "react";const appContent = {  key: "app",  content: {    getStarted: t<ReactNode>({      en: (        <>          Edite <code>src/App.tsx</code> e salve para recarregar        </>      ),      fr: (        <>          Éditez <code>src/App.tsx</code> et enregistrez pour recharger        </>      ),      es: (        <>          Edita <code>src/App.tsx</code> y guarda para recargar        </>      ),    }),    reactLink: {      href: "https://reactjs.org",      content: t({        en: "Aprenda React",        fr: "Apprendre React",        es: "Aprender React",      }),    },  },} satisfies DeclarationContent;export default appContent;

    Suas declarações de conteúdo podem ser definidas em qualquer lugar da sua aplicação assim que forem incluídas no diretório contentDir (por padrão, ./src). E corresponder à extensão do arquivo de declaração de conteúdo (por padrão, .content.{ts,tsx,js,jsx,mjs,cjs}). Para mais detalhes, consulte a documentação de declaração de conteúdo. Se seu arquivo de conteúdo incluir código TSX, você deve considerar importar import React from "react"; em seu arquivo de conteúdo.

    Passo 5: Utilizar o Intlayer no Seu Código

    Acesse seus dicionários de conteúdo ao longo de sua aplicação:

    src/App.tsx
    import logo from "./logo.svg";import "./App.css";import type { FC } from "react";import { IntlayerProvider, useIntlayer } from "react-intlayer";const AppContent: FC = () => {  const content = useIntlayer("app");  return (    <div className="App">      <img src={logo} className="App-logo" alt="logo" />      {content.getStarted}      <a        className="App-link"        href={content.reactLink.href.value}        target="_blank"        rel="noopener noreferrer"      >        {content.reactLink.content}      </a>    </div>  );};const App: FC = () => (  <IntlayerProvider>    <AppContent />  </IntlayerProvider>);export default App;

    Nota: Se você quiser usar seu conteúdo em um atributo string, como alt, title, href, aria-label, etc., você deve chamar o valor da função, como:

    jsx
    <img src={content.image.src.value} alt={content.image.value} />

    Para saber mais sobre o gancho useIntlayer, consulte a documentação.

    (Opcional) Passo 6: Mudar o idioma do seu conteúdo

    Para mudar o idioma do seu conteúdo, você pode usar a função setLocale fornecida pelo gancho useLocale. Esta função permite que você defina a localidade da aplicação e atualize o conteúdo de acordo.

    src/components/LocaleSwitcher.tsx
    import { Locales } from "intlayer";import { useLocale } from "react-intlayer";const LocaleSwitcher = () => {  const { setLocale } = useLocale();  return (    <button onClick={() => setLocale(Locales.English)}>      Mudar idioma para inglês    </button>  );};

    Para saber mais sobre o gancho useLocale, consulte a documentação.

    (Opcional) Passo 7: Adicionar Roteamento localizado à sua aplicação

    O objetivo deste passo é criar rotas exclusivas para cada idioma. Isso é útil para SEO e URLs amigáveis para SEO. Exemplo:

    plaintext
    - https://example.com/about- https://example.com/es/about- https://example.com/fr/about

    Por padrão, as rotas não são prefixadas para a localidade padrão. Se você quiser prefixar a localidade padrão, pode definir a opção middleware.prefixDefault como true em sua configuração. Veja a documentação de configuração para mais informações.

    Para adicionar roteamento localizado à sua aplicação, você pode criar um componente LocaleRouter que encapsula as rotas da sua aplicação e gerencia o roteamento baseado na localidade. Aqui está um exemplo usando React Router:

    src/components/LocaleRouter.tsx
    // Importando dependências e funções necessáriasimport { Locales, getConfiguration, getPathWithoutLocale } from "intlayer"; // Funções e tipos utilitários do 'intlayer'import type { FC, PropsWithChildren } from "react"; // Tipos do React para componentes funcionais e propsimport { IntlayerProvider } from "react-intlayer"; // Provedor para contexto de internacionalizaçãoimport {  BrowserRouter,  Routes,  Route,  useParams,  Navigate,  useLocation,} from "react-router-dom"; // Componentes de roteamento para gerenciamento de navegação// Desestruturando a configuração do Intlayerconst { internationalization, middleware } = getConfiguration();const { locales, defaultLocale } = internationalization;/** * Um componente que gerencia a localização e envolve os filhos com o contexto de localidade apropriado. * Ele gerencia a detecção e validação de localidade baseada em URLs. */const AppLocalized: FC<PropsWithChildren> = ({ children }) => {  const path = useLocation().pathname; // Obtém o caminho da URL atual  const { locale } = useParams<{ locale: Locales }>(); // Extrai o parâmetro de localidade da URL  // Determina a localidade atual, revertendo para a padrão se não fornecida  const currentLocale = locale ?? defaultLocale;  // Remove o prefixo da localidade do caminho para construir um caminho base  const pathWithoutLocale = getPathWithoutLocale(    path // Caminho da URL atual  );  /**   * Se middleware.prefixDefault for true, a localidade padrão deve sempre ser prefixada.   */  if (middleware.prefixDefault) {    // Valida a localidade    if (!locale || !locales.includes(locale)) {      // Redireciona para a localidade padrão com o caminho atualizado      return (        <Navigate          to={`/${defaultLocale}/${pathWithoutLocale}`}          replace // Substitui a entrada atual do histórico pela nova        />      );    }    // Envolve os filhos com o IntlayerProvider e define a localidade atual    return (      <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider>    );  } else {    /**     * Quando middleware.prefixDefault é falso, a localidade padrão não é prefixada.     * Certifique-se de que a localidade atual é válida e não é a localidade padrão.     */    if (      currentLocale.toString() !== defaultLocale.toString() &&      !locales        .filter(          (locale) => locale.toString() !== defaultLocale.toString() // Exclui a localidade padrão        )        .includes(currentLocale) // Verifica se a localidade atual está na lista de localizações válidas    ) {      // Redireciona para o caminho sem prefixo de localidade      return <Navigate to={pathWithoutLocale} replace />;    }    // Envolve os filhos com o IntlayerProvider e define a localidade atual    return (      <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider>    );  }};/** * Um componente de roteador que configura rotas específicas de localidade. * Ele usa o React Router para gerenciar a navegação e renderizar componentes localizados. */export const LocaleRouter: FC<PropsWithChildren> = ({ children }) => (  <BrowserRouter>    <Routes>      <Route        // Padrão de rota para capturar a localidade (ex: /en/, /fr/) e corresponder a todos os caminhos subsequentes        path="/:locale/*"        element={<AppLocalized>{children}</AppLocalized>} // Envolve os filhos com o gerenciamento de localidade      />      {        // Se o prefixo da localidade padrão estiver desativado, renderiza os filhos diretamente no caminho raiz        !middleware.prefixDefault && (          <Route            path="*"            element={<AppLocalized>{children}</AppLocalized>} // Envolve os filhos com o gerenciamento de localidade          />        )      }    </Routes>  </BrowserRouter>);

    (Opcional) Passo 8: Mudar a URL quando a localidade muda

    Para mudar a URL quando a localidade muda, você pode usar a propriedade onLocaleChange fornecida pelo gancho useLocale. Em paralelo, você pode usar os ganchos useLocation e useNavigate do react-router-dom para atualizar o caminho da URL.

    src/components/LocaleSwitcher.tsx
    import { useLocation, useNavigate } from "react-router-dom";import {  Locales,  getHTMLTextDir,  getLocaleName,  getLocalizedUrl,} from "intlayer";import { useLocale } from "react-intlayer";import { type FC } from "react";const LocaleSwitcher: FC = () => {  const location = useLocation(); // Obtém o caminho da URL atual. Exemplo: /fr/about  const navigate = useNavigate();  const changeUrl = (locale: Locales) => {    // Construa a URL com a localidade atualizada    // Exemplo: /es/about com a localidade definida para espanhol    const pathWithLocale = getLocalizedUrl(location.pathname, locale);    // Atualiza o caminho da URL    navigate(pathWithLocale);  };  const { locale, availableLocales, setLocale } = useLocale({    onLocaleChange: changeUrl,  });  return (    <ol>      {availableLocales.map((localeItem) => (        <li key={localeItem}>          <a            href={getLocalizedUrl(location.pathname, localeItem)}            hrefLang={localeItem}            aria-current={locale === localeItem ? "page" : undefined}            onClick={(e) => {              e.preventDefault();              setLocale(localeItem);            }}          >            <span>              {/* Idioma em sua própria Localidade - e.g. Français */}              {getLocaleName(localeItem, locale)}            </span>            <span dir={getHTMLTextDir(localeItem)} lang={localeItem}>              {/* Idioma na Localidade atual - e.g. Francés com a localidade atual definida para Locales.SPANISH */}              {getLocaleName(localeItem)}            </span>            <span dir="ltr" lang={Locales.ENGLISH}>              {/* Idioma em Inglês - e.g. French */}              {getLocaleName(localeItem, Locales.ENGLISH)}            </span>            <span>              {/* Idioma em sua própria Localidade - e.g. FR */}              {localeItem}            </span>          </a>        </li>      ))}    </ol>  );};

    Referências da documentação:

    Configurar TypeScript

    O Intlayer utiliza a augmentação de módulos para aproveitar os benefícios do TypeScript e tornar sua base de código mais forte.

    alt text

    alt text

    Certifique-se de que sua configuração do TypeScript inclua os tipos gerados automaticamente.

    tsconfig.json
    {  // ... Suas configurações existentes do TypeScript  "include": [    // ... Suas configurações existentes do TypeScript    "types", // Inclui os tipos gerados automaticamente  ],}

    Configuração do Git

    É recomendável ignorar os arquivos gerados pelo Intlayer. Isto permite que você evite cometê-los ao seu repositório Git.

    Para fazer isso, você pode adicionar as seguintes instruções ao seu arquivo .gitignore:

    .gitignore
    # Ignorar os arquivos gerados pelo Intlayer.intlayer

    Se você tiver uma ideia para melhorar esta documentação, sinta-se à vontade para contribuir enviando uma pull request no GitHub.

    Link do GitHub para a documentação