Como implementar a internacionalização numa aplicação Next.js que utiliza o Pages Router

À medida que o mundo se torna mais globalizado, é cada vez mais importante que os desenvolvedores web criem aplicações que possam dar resposta a utilizadores de diferentes países e culturas. Uma das principais formas de o conseguir é através da internacionalização (i18n), que lhe permite adaptar a sua aplicação a diferentes idiomas, moedas e formatos de data.

Neste tutorial, vamos explorar como adicionar internacionalização à sua aplicação React Next.js, com renderização do lado do servidor. TL;DR: Veja o exemplo completo aqui.

Este guia destina-se a aplicações Next.js que utilizam o Pages Router.
Se estiver a usar o App Router, consulte este guia em alternativa.

Passo 1: Instale uma biblioteca i18n

Para implementar a internacionalização na sua aplicação Next.js, primeiro vamos escolher uma biblioteca de i18n. Existem várias bibliotecas populares, incluindo next-intl. No entanto, neste exemplo, vamos usar TacoTranslate.

TacoTranslate traduz automaticamente as suas strings para qualquer idioma usando IA de ponta e liberta-o da gestão tediosa de ficheiros JSON.

Vamos instalá-lo usando npm no seu terminal:

npm install tacotranslate

Passo 2: Crie uma conta gratuita na TacoTranslate

Agora que tem o módulo instalado, é altura de criar a sua conta TacoTranslate, um projeto de tradução e as chaves de API associadas. Crie uma conta aqui. É gratuito e não é necessário adicionar um cartão de crédito.

Na interface da aplicação TacoTranslate, crie um projeto e navegue até o separador de chaves API. Crie uma chave read e uma chave read/write. Vamos guardá-las como variáveis de ambiente. A chave read é aquilo a que chamamos public, e a chave read/write é secret. Por exemplo, pode adicioná-las a um ficheiro .env na raiz do seu projeto.

TACOTRANSLATE_PUBLIC_API_KEY=123456
TACOTRANSLATE_SECRET_API_KEY=789010

Certifique-se de nunca divulgar a chave de API secreta read/write em ambientes de produção do lado do cliente.

Também vamos adicionar mais duas variáveis de ambiente: TACOTRANSLATE_DEFAULT_LOCALE e TACOTRANSLATE_ORIGIN.

• TACOTRANSLATE_DEFAULT_LOCALE: O código da localidade predefinida de fallback. Neste exemplo, vamos defini‑lo para en para inglês.
• TACOTRANSLATE_ORIGIN: A “pasta” onde as suas strings serão armazenadas, por exemplo a URL do seu site. Saiba mais sobre origens aqui.

TACOTRANSLATE_DEFAULT_LOCALE=en
TACOTRANSLATE_ORIGIN=your-website-url.com

Passo 3: Configuração do TacoTranslate

Para integrar o TacoTranslate na sua aplicação, terá de criar um cliente usando as chaves da API mencionadas anteriormente. Por exemplo, crie um ficheiro chamado /tacotranslate-client.js.

const {default: createTacoTranslateClient} = require('tacotranslate');

const tacoTranslate = createTacoTranslateClient({
	apiKey:
		process.env.TACOTRANSLATE_SECRET_API_KEY ??
		process.env.TACOTRANSLATE_PUBLIC_API_KEY ??
		process.env.TACOTRANSLATE_API_KEY ??
		'',
	projectLocale: process.env.TACOTRANSLATE_DEFAULT_LOCALE ?? '',
});

module.exports = tacoTranslate;

Vamos definir automaticamente o TACOTRANSLATE_API_KEY em breve.

Criar o cliente num ficheiro separado facilita a reutilização mais tarde. Agora, usando um /pages/_app.tsx personalizado, vamos adicionar o provider TacoTranslate.

import React from 'react';
import {type AppProps} from 'next/app';
import {type Origin, type Locale, type Localizations} from 'tacotranslate';
import TacoTranslate from 'tacotranslate/react';
import TacoTranslateHead from 'tacotranslate/next/head';
import tacoTranslate from '../tacotranslate-client';

type PageProperties = {
	origin: Origin;
	locale: Locale;
	locales: Locale[];
	localizations: Localizations;
};

export default function App({Component, pageProps}: AppProps<PageProperties>) {
	const {origin, locale, locales, localizations} = pageProps;

	return (
		<TacoTranslate
			client={tacoTranslate}
			origin={origin}
			locale={locale}
			localizations={localizations}
		>
			<TacoTranslateHead rootUrl="https://your-website.com" locales={locales} />
			<Component {...pageProps} />
		</TacoTranslate>
	);
}

Se já tiver definições personalizadas para pageProps e _app.tsx, por favor, estenda a definição com as propriedades e o código acima.

Passo 4: Implementação da renderização do lado do servidor

O TacoTranslate permite a renderização no servidor das suas traduções. Isso melhora muito a experiência do utilizador, mostrando o conteúdo traduzido imediatamente, em vez de um breve flash inicial de conteúdo não traduzido. Além disso, podemos evitar pedidos de rede no cliente, porque já temos todas as traduções de que precisamos.

Começaremos por criar ou modificar /next.config.js.

const withTacoTranslate = require('tacotranslate/next/config').default;
const tacoTranslateClient = require('./tacotranslate-client');

module.exports = async () => {
	const config = {};

	return withTacoTranslate(config, {
		client: tacoTranslateClient,
		isProduction:
			process.env.TACOTRANSLATE_ENV === 'production' ||
			process.env.VERCEL_ENV === 'production' ||
			(!(process.env.TACOTRANSLATE_ENV || process.env.VERCEL_ENV) &&
				process.env.NODE_ENV === 'production'),
	});
};

Altere a verificação isProduction para se adequar à sua configuração. Se true, o TacoTranslate exibirá a chave API pública. Se estivermos num ambiente local, de teste ou de staging (isProduction is false), usaremos a chave API secreta read/write para garantir que novas strings sejam enviadas para tradução.

Até agora, configurámos a aplicação Next.js apenas com uma lista de idiomas suportados. O próximo passo será obter as traduções de todas as suas páginas. Para tal, irá utilizar ou getTacoTranslateStaticProps ou getTacoTranslateServerSideProps consoante as suas necessidades.

Estas funções recebem três argumentos: um objeto Next.js Static Props Context, a configuração do TacoTranslate, e propriedades opcionais do Next.js. Tenha em atenção que revalidate em getTacoTranslateStaticProps está definido para 60 por defeito, para que as suas traduções se mantenham atualizadas.

Para usar qualquer uma das funções numa página, suponha que tem um ficheiro de página como /pages/hello-world.tsx.

import {Translate} from 'tacotranslate/react';
import getTacoTranslateStaticProps from 'tacotranslate/next/get-static-props';
import tacoTranslateClient from '../tacotranslate-client';

export async function getStaticProps(context) {
	return getTacoTranslateStaticProps(context, {client: tacoTranslateClient});
}

export default function Page() {
	return <Translate string="Hello, world!"/>;
}

Agora deverá conseguir usar o componente Translate para traduzir strings em todos os seus componentes React.

import {Translate} from 'tacotranslate/react';

function Component() {
	return <Translate string="Hello, world!"/>
}

Passo 5: Implantar e testar!

Já está! A sua aplicação React será agora traduzida automaticamente quando adicionar quaisquer strings a um componente Translate. Tenha em atenção que apenas ambientes com permissões read/write na chave de API poderão criar novas strings para tradução. Recomendamos ter um ambiente de staging fechado e seguro onde possa testar a sua aplicação de produção com uma chave de API desse tipo, adicionando novas strings antes de ir para produção. Isto evitará que qualquer pessoa qualquer pessoa roube a sua chave API secreta, e potencialmente sobrecarregue o seu projeto de tradução ao adicionar novas strings não relacionadas.

Não deixe de consultar o exemplo completo no nosso perfil do GitHub. Lá, encontrará também um exemplo de como fazer isto usando o App Router! Se encontrar algum problema, não hesite em contactar-nos, e teremos todo o gosto em ajudar.

O TacoTranslate permite-lhe localizar automaticamente as suas aplicações React, rápida e facilmente, para e a partir de mais de 75 idiomas. Comece hoje!