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 capazes de servir 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 línguas, moedas e formatos de data.

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

Este guia destina-se a aplicações Next.js que estão a utilizar o Pages Router.
Se estiver a utilizar o App Router, consulte este guia em vez disso.

Passo 1: Instalar 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, iremos usar TacoTranslate.

O TacoTranslate traduz automaticamente as suas strings para qualquer idioma usando IA de ponta, e poupa-lhe a gestão tediosa de ficheiros JSON.

Vamos instalá-lo usando npm no seu terminal:

npm install tacotranslate

Passo 2: Crie uma conta gratuita no TacoTranslate

Agora que instalou o módulo, é hora de criar a sua conta TacoTranslate, um projeto de tradução e as respectivas chaves de API. Crie uma conta aqui. É gratuito e não requer a adição de um cartão de crédito.

Na interface da aplicação TacoTranslate, crie um projeto e navegue até ao 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 que chamamos de public e a chave read/write é a 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 expor 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 de locale de fallback predefinido. Neste exemplo, vamos defini-lo como en (Inglês).
• TACOTRANSLATE_ORIGIN: A “pasta” onde as suas strings serão armazenadas, como o URL do seu site. Leia mais sobre origens aqui.

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

Passo 3: Configurar o TacoTranslate

Para integrar o TacoTranslate na sua aplicação, vai precisar de criar um cliente usando as chaves de 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 TACOTRANSLATE_API_KEY em breve.

Criar o cliente num ficheiro separado torna mais fácil reutilizá-lo 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 pageProps e _app.tsx personalizados, 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 do lado do servidor das suas traduções. Isso melhora muito a experiência do utilizador, ao apresentar imediatamente o conteúdo traduzido, em vez de mostrar primeiro um breve aparecimento 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, apenas configurámos a aplicação Next.js com uma lista de idiomas suportados. O próximo passo é obter as traduções de todas as suas páginas. Para isso, deverá usar o getTacoTranslateStaticProps ou o getTacoTranslateServerSideProps conforme as suas necessidades.

Estas funções aceitam três argumentos: um objeto Next.js Static Props Context, a configuração do TacoTranslate e propriedades opcionais do Next.js. Note que revalidate em getTacoTranslateStaticProps está definido para 60 por omissão, 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 cadeias de texto 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 da API poderão criar novas strings para serem traduzidas. 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 passar para produção. Isto irá impedir que qualquer pessoa qualquer roube a sua chave secreta da API, e potencialmente infle 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á, também encontrará um exemplo de como fazer isto usando o App Router! Se encontrar algum problema, não hesite em entrar em contacto, e teremos todo o gosto em ajudar.

O TacoTranslate permite localizar automaticamente as suas aplicações React de e para mais de 75 idiomas. Comece hoje!