Dokumentation: Beste Praktiken

Beste Praktiken

German

Setze URLs in Variablen

Beim Übersetzen von Zeichenketten, die URLs oder ähnliche Daten enthalten, gilt es als gute Praxis, diese URLs in Variablen zu speichern und sie dann innerhalb Ihrer Templates zu referenzieren.

<Translate
	string={`Click <a href="{{url}}">here</a>`}
	variables={{url: 'https://tacotranslate.com'}}
/>

Beim Übersetzen des Textes interaktiver Elemente wie Schaltflächen ist es wichtig, ARIA-Labels einzufügen, um die Barrierefreiheit sicherzustellen. ARIA-Labels helfen Bildschirmlesern, eine beschreibende Information über die Funktion des Elements bereitzustellen.

Zum Beispiel, wenn Sie eine Schaltfläche haben, die es Nutzern ermöglicht, Text aus einem Codeblock zu kopieren, können Sie das Attribut aria-label verwenden, um eine klare Beschreibung bereitzustellen:

<Translate
	aria-label={useTranslation('Copy to clipboard')}
	string="Copy"
/>

Irgendetwas daran fühlt sich sehr meta an.

Globale Origins-Array und mehrere Component-Origins

Dieses Muster funktioniert nur bei Verwendung des Next.js Pages Router.

Bei der Arbeit mit größeren Anwendungen ist es vorteilhaft, Zeichenketten und Übersetzungen in mehrere, kleinere Origins aufzuteilen. Dieser Ansatz hilft, die Bundle-Größen und Übertragungszeiten zu reduzieren und sorgt für eine effiziente und skalierbare Lokalisierung.

Während dies beim Nur-Client-seitigen Rendering straightforward ist, wird die Verwaltung der Origins schnell komplex, wenn Übersetzungen für das serverseitige Rendering abgerufen werden. Sie können die Origin-Verwaltung jedoch automatisieren, indem Sie das origins Array des TacoTranslate Clients nutzen.

Betrachten Sie dieses Beispiel, bei dem wir unsere Komponenten und Seiten in separate Dateien aufgeteilt haben.

components/pricing-table.tsx

import TacoTranslate, {Translate} from 'tacotranslate/react';
import tacoTranslate from '../tacotranslate-client';

// Set an origin name for this component
const origin = 'components/pricing-table';

// Push the origin into the origins array as this file is imported
tacoTranslate.origins.push(origin);

export default function PricingTable() {
	return (
		<TacoTranslate origin={origin}>
			<Translate string="Pricing table" />
			// ...
		</TacoTranslate>
	);
}

pages/pricing.tsx

import TacoTranslate, {Translate} from 'tacotranslate/react';
import getTacoTranslateStaticProps from 'tacotranslate/next/get-static-props';
import tacoTranslateClient from '../tacotranslate-client';
import PricingTable from '../components/pricing-table';

const origin = 'pages/pricing';
tacoTranslateClient.origins.push(origin);

export default function PricingPage() {
	return (
		<TacoTranslate origin={origin}>
			<Translate string="Pricing page" />
			<PricingTable />
		</TacoTranslate>
	);
}

// We will now fetch translations for all imported components and their origins automatically
export async function getStaticProps(context) {
	return getTacoTranslateStaticProps(context, {client: tacoTranslateClient});
}

Siehe unsere Beispiele für serverseitiges Rendering für weitere Informationen über getTacoTranslateStaticProps.

Fehlerbehandlung und Debugging

Beste Praktiken

ARIA-Labels verwenden

Globale Origins-Array und mehrere Component-Origins