O conteúdo desta página foi traduzido com uma IA.
Veja a última versão do conteúdo original em inglêsIntrodução à Internacionalização (i18n) com Intlayer, Vite e Preact
Este pacote está em desenvolvimento. Veja o issue para mais informações. Mostre seu interesse no Intlayer para Preact curtindo o issue.
Veja o Template de Aplicação no GitHub.
O que é o Intlayer?
Intlayer é uma biblioteca de internacionalização (i18n) inovadora e de código aberto, 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 ao TypeScript com tipos autogerados, melhorando a autocompletação e a detecção de erros.
- Aproveitar recursos avançados, como detecção dinâmica de localidade e troca de idiomas.
Guia Passo a Passo para Configurar o Intlayer em uma Aplicação Vite e Preact
Passo 1: Instale as Dependências
Instale os pacotes necessários usando npm:
npm install intlayer preact-intlayer vite-intlayer
intlayer
O pacote principal que fornece ferramentas de internacionalização para gerenciamento de configuração, tradução, declaração de conteúdo, transpilações e comandos CLI.
preact-intlayer O pacote que integra o Intlayer com a aplicação Preact. Ele fornece provedores de contexto e hooks para internacionalização no Preact.
vite-intlayer Inclui o plugin Vite para integrar o Intlayer com o empacotador Vite, bem como middleware para detectar a localidade preferida do usuário, gerenciar cookies e lidar com redirecionamento de URLs.
Passo 2: Configuração do seu projeto
Crie um arquivo de configuração para configurar os idiomas da sua aplicação:
import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = { internationalization: { locales: [ Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH, // Seus outros idiomas ], defaultLocale: Locales.ENGLISH, },};export default config;
Através deste arquivo de configuração, você pode configurar URLs localizados, redirecionamento de middleware, nomes de cookies, a localização e extensão de suas declarações de conteúdo, desativar logs do Intlayer no console e muito mais. Para uma lista completa de parâmetros disponíveis, consulte a documentação de configuração.
Passo 3: Integre o Intlayer na Configuração do Vite
Adicione o plugin intlayer na sua configuração.
import { defineConfig } from "vite";import preact from "@preact/preset-vite";import { intlayerPlugin } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({ plugins: [preact(), intlayerPlugin()],});
O plugin intlayerPlugin() do Vite é usado para integrar o Intlayer com o Vite. Ele garante a construção de arquivos de declaração de conteúdo e os monitora no modo de desenvolvimento. Ele define variáveis de ambiente do Intlayer dentro da aplicação Vite. Além disso, fornece aliases para otimizar o desempenho.
Passo 4: Declare Seu Conteúdo
Crie e gerencie suas declarações de conteúdo para armazenar traduções:
import { t, type Dictionary } from "intlayer";const appContent = { key: "app", content: { viteLogo: t({ pt: "Logotipo do Vite", en: "Vite logo", fr: "Logo Vite", es: "Logo Vite", }), preactLogo: t({ pt: "Logotipo do Preact", en: "Preact logo", fr: "Logo Preact", es: "Logo Preact", }), title: "Vite + Preact", count: t({ pt: "o contador é ", en: "count is ", fr: "le compte est ", es: "el recuento es ", }), edit: t({ pt: "Edite src/app.tsx e salve para testar HMR", en: "Edit src/app.tsx and save to test HMR", fr: "Éditez src/app.tsx et enregistrez pour tester HMR", es: "Edita src/app.tsx y guarda para probar HMR", }), readTheDocs: t({ pt: "Clique nos logotipos do Vite e Preact para saber mais", en: "Click on the Vite and Preact logos to learn more", fr: "Cliquez sur les logos Vite et Preact pour en savoir plus", es: "Haga clic en los logotipos de Vite y Preact para obtener más información", }), },} satisfies Dictionary;export default appContent;
Suas declarações de conteúdo podem ser definidas em qualquer lugar do seu aplicativo, desde que sejam incluídas no diretório contentDir (por padrão, ./src). E correspondam à extensão do arquivo de declaração de conteúdo (por padrão, .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}). Para mais detalhes, consulte a documentação de declaração de conteúdo. Se o seu arquivo de conteúdo incluir código TSX, talvez seja necessário importar import { h } from "preact"; ou garantir que sua pragma JSX esteja configurada corretamente para o Preact.
Passo 5: Utilize o Intlayer no Seu Código
Acesse seus dicionários de conteúdo em todo o seu aplicativo:
import { useState } from "preact/hooks";import type { FunctionalComponent } from "preact";import preactLogo from "./assets/preact.svg"; // Supondo que você tenha um preact.svgimport viteLogo from "/vite.svg";import "./app.css"; // Supondo que seu arquivo CSS seja nomeado app.cssimport { IntlayerProvider, useIntlayer } from "preact-intlayer";const AppContent: FunctionalComponent = () => { const [count, setCount] = useState(0); const content = useIntlayer("app"); return ( <> <div> <a href="https://vitejs.dev" target="_blank"> <img src={viteLogo} class="logo" alt={content.viteLogo.value} /> </a> <a href="https://preactjs.com" target="_blank"> <img src={preactLogo} class="logo preact" alt={content.preactLogo.value} /> </a> </div> <h1>{content.title}</h1> <div class="card"> <button onClick={() => setCount((count) => count + 1)}> {content.count} {count} </button> <p>{content.edit}</p> </div> <p class="read-the-docs">{content.readTheDocs}</p> </> );};const App: FunctionalComponent = () => ( <IntlayerProvider> <AppContent /> </IntlayerProvider>);export default App;
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} />
Nota: No Preact, className é tipicamente escrito como class.
Para saber mais sobre o hook useIntlayer, consulte a documentação (A API é semelhante para preact-intlayer).
(Opcional) Passo 6: Alterar o idioma do seu conteúdo
Para alterar o idioma do seu conteúdo, você pode usar a função setLocale fornecida pelo hook useLocale. Essa função permite definir o locale do aplicativo e atualizar o conteúdo de acordo.
import type { FunctionalComponent } from "preact";import { Locales } from "intlayer";import { useLocale } from "preact-intlayer";const LocaleSwitcher: FunctionalComponent = () => { const { setLocale } = useLocale(); return ( <button onClick={() => setLocale(Locales.PORTUGUESE)}> Alterar idioma para Portuguêsimport { Locales } from "intlayer";import { useLocale } from "preact-intlayer";const LocaleSwitcher = () => { const { setLocale } = useLocale(); return ( <button onClick={() => setLocale(Locales.ENGLISH)}> Alterar idioma para Inglês </button> );};export default LocaleSwitcher;
Para saber mais sobre o hook useLocale, consulte a documentação (A API é semelhante para preact-intlayer).
(Opcional) Etapa 7: Adicione roteamento localizado à sua aplicação
O objetivo desta etapa é criar rotas únicas para cada idioma. Isso é útil para SEO e URLs amigáveis para SEO. Exemplo:
- 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 o idioma padrão. Se você deseja prefixar o idioma padrão, pode definir a opção middleware.prefixDefault como true na sua configuração. Consulte a documentação de configuração para mais informações.
Para adicionar roteamento localizado à sua aplicação, você pode criar um componente LocaleRouter que envolve as rotas da sua aplicação e gerencia o roteamento baseado no idioma. Aqui está um exemplo usando preact-iso:
Primeiro, instale o preact-iso:
npm install preact-iso
import { type Locales, configuration, getPathWithoutLocale } from "intlayer";import { ComponentChildren, FunctionalComponent } from "preact";import { IntlayerProvider } from "preact-intlayer";import { LocationProvider, useLocation } from "preact-iso";import { useEffect } from "preact/hooks";const { internationalization, middleware } = configuration;const { locales, defaultLocale } = internationalization;const Navigate: FunctionalComponent<{ to: string; replace?: boolean }> = ({ to, replace,}) => { const { route } = useLocation(); useEffect(() => { route(to, replace); }, [to, replace, route]); return null;};/** * Um componente que gerencia a localização e envolve os filhos com o contexto de idioma apropriado. * Ele gerencia a detecção e validação de idioma baseada na URL. */const AppLocalized: FunctionalComponent<{ children: ComponentChildren; locale?: Locales;}> = ({ children, locale }) => { const { path: pathname, url } = useLocation(); if (!url) { return null; } const search = url.substring(pathname.length); // Determina o idioma atual, retornando ao padrão se não for fornecido const currentLocale = locale ?? defaultLocale; // Remove o prefixo do idioma do caminho para construir um caminho base const pathWithoutLocale = getPathWithoutLocale( pathname // Caminho atual da URL ); /** * Se middleware.prefixDefault for verdadeiro, o idioma padrão deve sempre ser prefixado. */ if (middleware.prefixDefault) { // Valida o idioma if (!locale || !locales.includes(locale)) { // Redireciona para o idioma padrão com o caminho atualizado return ( <Navigate to={`/${defaultLocale}/${pathWithoutLocale}${search}`} replace // Substitui a entrada atual do histórico pela nova /> ); } // Envolve os filhos com o IntlayerProvider e define o idioma atual return ( <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider> ); } else { /** * Quando middleware.prefixDefault é falso, o idioma padrão não é prefixado. * Garante que o idioma atual seja válido e não o idioma padrão. */ if ( currentLocale.toString() !== defaultLocale.toString() && !locales .filter( (loc) => loc.toString() !== defaultLocale.toString() // Exclui o idioma padrão ) .includes(currentLocale) // Verifica se o idioma atual está na lista de idiomas válidos ) { // Redireciona para o caminho sem o prefixo do idioma return <Navigate to={`${pathWithoutLocale}${search}`} replace />; } // Envolve os filhos com o IntlayerProvider e define o idioma atual return ( <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider> ); }};const RouterContent: FunctionalComponent<{ children: ComponentChildren;}> = ({ children }) => { const { path } = useLocation(); if (!path) { return null; } const pathLocale = path.split("/")[1] as Locales; const isLocaleRoute = locales .filter((locale) => middleware.prefixDefault || locale !== defaultLocale) .some((locale) => locale.toString() === pathLocale); if (isLocaleRoute) { return <AppLocalized locale={pathLocale}>{children}</AppLocalized>; } return ( <AppLocalized locale={!middleware.prefixDefault ? defaultLocale : undefined} > {children} </AppLocalized> );};/** * Um componente de roteador que configura rotas específicas para idiomas. * Ele usa preact-iso para gerenciar a navegação e renderizar componentes localizados. */export const LocaleRouter: FunctionalComponent<{ children: ComponentChildren;}> = ({ children }) => ( <LocationProvider> <RouterContent>{children}</RouterContent> </LocationProvider>);
Então, você pode usar o componente LocaleRouter em sua aplicação:
import { LocaleRouter } from "./components/LocaleRouter";import type { FunctionalComponent } from "preact";// ... Seu componente AppContent (definido no Passo 5)const App: FunctionalComponent = () => ( <LocaleRouter> <AppContent /> </LocaleRouter>);export default App;
Paralelamente, você também pode usar o intLayerMiddlewarePlugin para adicionar roteamento no lado do servidor à sua aplicação. Este plugin detectará automaticamente o locale atual com base na URL e definirá o cookie de locale apropriado. Se nenhum locale for especificado, o plugin determinará o locale mais apropriado com base nas preferências de idioma do navegador do usuário. Se nenhum locale for detectado, ele redirecionará para o locale padrão.
import { defineConfig } from "vite";import preact from "@preact/preset-vite";import { intlayerPlugin, intLayerMiddlewarePlugin } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({ plugins: [preact(), intlayerPlugin(), intLayerMiddlewarePlugin()],});
(Opcional) Passo 8: Alterar a URL quando o locale muda
import { useLocation, route } from "preact-iso";import { Locales, getHTMLTextDir, getLocaleName, getLocalizedUrl,} from "intlayer";import { useLocale } from "preact-intlayer";import type { FunctionalComponent } from "preact";const LocaleSwitcher: FunctionalComponent = () => { const location = useLocation(); const { locale, availableLocales, setLocale } = useLocale({ onLocaleChange: (newLocale) => { const currentFullPath = location.url; // preact-iso fornece a URL completa // Constrói a URL com o idioma atualizado // Exemplo: /es/about?foo=bar const pathWithLocale = getLocalizedUrl(currentFullPath, newLocale); // Atualiza o caminho da URL route(pathWithLocale, true); // true para substituir }, }); return ( <div> <button popovertarget="localePopover">{getLocaleName(locale)}</button> <div id="localePopover" popover="auto"> {availableLocales.map((localeItem) => ( <a href={getLocalizedUrl(location.url, localeItem)} hreflang={localeItem} aria-current={locale === localeItem ? "page" : undefined} onClick={(e) => { e.preventDefault(); setLocale(localeItem); // A navegação programática após definir o idioma será tratada por onLocaleChange }} key={localeItem} > <span> {/* Idioma - ex.: FR */} {localeItem} </span> <span> {/* Idioma no próprio idioma - ex.: Français */} {getLocaleName(localeItem, localeItem)} </span> <span dir={getHTMLTextDir(localeItem)} lang={localeItem}> {/* Idioma no idioma atual - ex.: Francés com o idioma atual definido como Locales.SPANISH */} {getLocaleName(localeItem, locale)} </span> <span dir="ltr" lang={Locales.ENGLISH}> {/* Idioma em inglês - ex.: French */} {getLocaleName(localeItem, Locales.ENGLISH)} </span> </a> ))} </div> </div> );};export default LocaleSwitcher;
Referências da documentação:
- useLocale hook (A API é semelhante para preact-intlayer)
- getLocaleName hook
- getLocalizedUrl hook
- getHTMLTextDir hook
- hreflang attribute
- lang attribute
- dir attribute
- aria-current attribute
- Popover API
Abaixo está o Passo 9 atualizado com explicações adicionais e exemplos de código refinados:
(Opcional) Passo 9: Alterar os Atributos de Idioma e Direção do HTML
Quando sua aplicação suporta múltiplos idiomas, é crucial atualizar os atributos lang e dir da tag <html> para corresponder ao idioma atual. Fazer isso garante:
- Acessibilidade: Leitores de tela e tecnologias assistivas dependem do atributo lang correto para pronunciar e interpretar o conteúdo com precisão.
- Renderização de Texto: O atributo dir (direção) garante que o texto seja renderizado na ordem correta (por exemplo, da esquerda para a direita para inglês, da direita para a esquerda para árabe ou hebraico), essencial para a legibilidade.
- SEO: Os motores de busca usam o atributo lang para determinar o idioma da sua página, ajudando a exibir o conteúdo localizado correto nos resultados de busca.
Ao atualizar esses atributos dinamicamente quando o idioma muda, você garante uma experiência consistente e acessível para os usuários em todos os idiomas suportados.
Implementando o Hook
Crie um hook personalizado para gerenciar os atributos HTML. O hook escuta as mudanças de idioma e atualiza os atributos de forma correspondente:
import { useEffect } from "preact/hooks"; import { useLocale } from "preact-intlayer"; import { getHTMLTextDir } from "intlayer";
/**
- Atualiza os atributos lang e dir do elemento HTML com base no idioma atual.
- lang: Informa navegadores e motores de busca sobre o idioma da página.
- dir: Garante a ordem de leitura correta (por exemplo, 'ltr' para inglês, 'rtl' para árabe). -
- Essa atualização dinâmica é essencial para renderização de texto adequada, acessibilidade e SEO. */ export const useI18nHTMLAttributes = () => { const { locale } = useLocale();
useEffect(() => { // Atualiza o atributo de idioma para o idioma atual. document.documentElement.lang = locale;
// Define a direção do texto com base no idioma atual. document.documentElement.dir = getHTMLTextDir(locale);}, [locale]); };
```jsx fileName="src/hooks/useI18nHTMLAttributes.jsx" codeFormat="esm" import { useEffect } from "preact/hooks"; import { useLocale } from "preact-intlayer"; import { getHTMLTextDir } from "intlayer"; /** * Atualiza os atributos `lang` e `dir` do elemento HTML <html> com base no idioma atual. */ export const useI18nHTMLAttributes = () => { const { locale } = useLocale(); useEffect(() => { document.documentElement.lang = locale; document.documentElement.dir = getHTMLTextDir(locale); }, [locale]); };Usando o Hook na Sua Aplicação
Integre o hook no seu componente principal para que os atributos HTML sejam atualizados sempre que o idioma mudar:
import type { FunctionalComponent } from "preact";import { IntlayerProvider } from "preact-intlayer"; // useIntlayer já importado se AppContent precisarimport { useI18nHTMLAttributes } from "./hooks/useI18nHTMLAttributes";import "./app.css";// Definição de AppContent do Passo 5const AppWithHooks: FunctionalComponent = () => { // Aplica o hook para atualizar os atributos lang e dir da tag <html> com base no idioma. useI18nHTMLAttributes(); // Supondo que AppContent seja o componente principal de exibição de conteúdo do Passo 5 return <AppContent />;};const App: FunctionalComponent = () => ( <IntlayerProvider> <AppWithHooks /> </IntlayerProvider>);export default App;
Ao aplicar essas alterações, sua aplicação irá:
- Garantir que o atributo idioma (lang) reflita corretamente o idioma atual, o que é importante para SEO e comportamento do navegador.
- Ajustar a direção do texto (dir) de acordo com o idioma, melhorando a legibilidade e usabilidade para idiomas com ordens de leitura diferentes.
- Proporcionar uma experiência mais acessível, já que tecnologias assistivas dependem desses atributos para funcionar de forma ideal.
(Opcional) Passo 10: Criando um Componente de Link Localizado
Para garantir que a navegação da sua aplicação respeite o idioma atual, você pode criar um componente de Link personalizado. Este componente automaticamente adiciona o prefixo do idioma atual às URLs internas.
Esse comportamento é útil por vários motivos:
- SEO e Experiência do Usuário: URLs localizadas ajudam os motores de busca a indexar corretamente as páginas específicas de cada idioma e fornecem aos usuários conteúdo no idioma preferido.
- Consistência: Usando um link localizado em toda a aplicação, você garante que a navegação permaneça no idioma atual, evitando mudanças inesperadas de idioma.
- Manutenibilidade: Centralizar a lógica de localização em um único componente simplifica o gerenciamento de URLs.
Para Preact com preact-iso, tags padrão <a> são normalmente usadas para navegação, e o preact-iso gerencia o roteamento. Se você precisar de navegação programática ao clicar (por exemplo, para realizar ações antes de navegar), pode usar a função route de useLocation. Veja como criar um componente de âncora personalizado que localiza URLs:
import { getLocalizedUrl } from "intlayer";import { useLocale, useLocation, route } from "preact-intlayer"; // Supondo que useLocation e route possam ser do preact-iso via preact-intlayer se reexportados, ou importados diretamente// Se não forem reexportados, importe diretamente: import { useLocation, route } from "preact-iso";import type { JSX } from "preact"; // Para HTMLAttributesimport { forwardRef } from "preact/compat"; // Para encaminhar refsexport interface LocalizedLinkProps extends JSX.HTMLAttributes<HTMLAnchorElement> { href: string; replace?: boolean; // Opcional: para substituir o estado do histórico}/** * Função utilitária para verificar se uma URL é externa. * Se a URL começar com http:// ou https://, é considerada externa. */export const checkIsExternalLink = (href?: string): boolean => /^https?:\/\//.test(href ?? "");/** * Um componente de Link personalizado que adapta o atributo href com base no idioma atual. * Para links internos, ele usa `getLocalizedUrl` para adicionar o prefixo do idioma à URL (por exemplo, /pt/sobre). * Isso garante que a navegação permaneça dentro do contexto do idioma atual. * Ele usa uma tag padrão <a>, mas pode acionar navegação no cliente usando o `route` do preact-iso. */export const LocalizedLink = forwardRef<HTMLAnchorElement, LocalizedLinkProps>( ({ href, children, onClick, replace = false, ...props }, ref) => { const { locale } = useLocale(); const location = useLocation(); // do preact-iso const isExternalLink = checkIsExternalLink(href); const hrefI18n = href && !isExternalLink ? getLocalizedUrl(href, locale) : href; const handleClick = (event: JSX.TargetedMouseEvent<HTMLAnchorElement>) => { if (onClick) { onClick(event); } if ( !isExternalLink && href && // Garante que href está definido event.button === 0 && // Clique esquerdo !event.metaKey && !event.ctrlKey && !event.shiftKey && !event.altKey && // Verificação de modificadores padrão !props.target // Não direcionando para uma nova aba/janela ) { event.preventDefault(); if (location.url !== hrefI18n) { // Navega apenas se a URL for diferente route(hrefI18n, replace); // Usa o route do preact-iso } } }; return ( <a href={hrefI18n} ref={ref} onClick={handleClick} {...props}> {children} </a> ); });
Como Funciona
- Detectando Links Externos:
A função auxiliar checkIsExternalLink determina se uma URL é externa. Links externos permanecem inalterados. - Recuperando o Idioma Atual:
O hook useLocale fornece o idioma atual. - Localizando a URL:
Para links internos, getLocalizedUrl adiciona o prefixo do idioma atual à URL. - Navegação no Lado do Cliente:
A função handleClick verifica se é um link interno e se a navegação padrão deve ser evitada. Se sim, utiliza a função route do preact-iso (obtida via useLocation ou importada diretamente) para realizar a navegação no lado do cliente. Isso proporciona um comportamento semelhante a uma SPA sem recarregar a página inteira. - Retornando o Link:
O componente retorna um elemento <a> com a URL localizada e o manipulador de clique personalizado.
Configurar TypeScript
O Intlayer utiliza a ampliação de módulos para aproveitar os benefícios do TypeScript e tornar sua base de código mais robusta.
Certifique-se de que sua configuração do TypeScript inclua os tipos gerados automaticamente.
{ // ... Suas configurações existentes do TypeScript "compilerOptions": { // ... "jsx": "react-jsx", "jsxImportSource": "preact", // Recomendado para Preact 10+ // ... }, "include": [ // ... Suas configurações existentes do TypeScript ".intlayer/**/*.ts", // Inclua os tipos gerados automaticamente ],}
Certifique-se de que seu tsconfig.json esteja configurado para Preact, especialmente jsx e jsxImportSource ou jsxFactory/jsxFragmentFactory para versões mais antigas do Preact, caso não esteja usando os padrões do preset-vite.
Configuração do Git
Recomenda-se ignorar os arquivos gerados pelo Intlayer. Isso permite evitar que sejam adicionados ao seu repositório Git.
Para isso, você pode adicionar as seguintes instruções ao seu arquivo .gitignore:
# Ignore os arquivos gerados pelo Intlayer.intlayer
Extensão do VS Code
Para melhorar sua experiência de desenvolvimento com o Intlayer, você pode instalar a Extensão Oficial do Intlayer para VS Code.
Instale no VS Code Marketplace
Esta extensão fornece:
- Autocompletar para chaves de tradução.
- Detecção de erros em tempo real para traduções ausentes.
- Pré-visualizações inline de conteúdo traduzido.
- Ações rápidas para criar e atualizar traduções facilmente.
Para mais detalhes sobre como usar a extensão, consulte a documentação da Extensão do Intlayer para VS Code.
Vá Além
Para ir além, você pode implementar o editor visual ou externalizar seu conteúdo usando o CMS.
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