Dokumentasie: Beste praktyke

Beste praktyke

Afrikaans

Sit URL's in veranderlikes

Wanneer jy stringe vertaal wat URL's of soortgelyke data bevat, is dit 'n goeie praktyk om hierdie URL's in veranderlikes te plaas en dan daarnaar in jou sjablone te verwys.

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

Wanneer u die teks van interaktiewe elemente soos knoppies vertaal, is dit belangrik om ARIA-etikette in te sluit om toeganklikheid te verseker. ARIA-etikette help skermslesers om beskrywende inligting oor die element se funksie te verskaf.

Byvoorbeeld, as u 'n knoppie het wat gebruikers toelaat om teks uit 'n kodeblok te kopieer, kan u die aria-label attribuut gebruik om 'n duidelike beskrywing te verskaf:

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

Iets hieraan voel baie meta.

Globale oorspronge-array en meerdere komponent-oorspronge

Hierdie patroon werk slegs wanneer dit met die Next.js Pages Router gebruik word.

Wanneer jy met groter toepassings werk, is dit voordelig om stringe en vertalings in verskeie, kleiner origine te verdeel. Hierdie benadering help om bundelgroottes en oordragtye te verminder, en verseker doeltreffende en skaalbare lokalisering.

Alhoewel dit eenvoudig is wanneer daar slegs aan die kliëntkant gerender word, word die hantering van origine vinnig ingewikkeld wanneer vertalings vir bedienerkant-rendering opgevra word. Jy kan egter die hantering van origine outomatiseer deur die TacoTranslate-kliënt se origins reeks te gebruik.

Oorweeg hierdie voorbeeld, waar ons komponente en bladsye in aparte lêers geskei het.

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});
}

Sien ons voorbeelde van bedienerkant-rendering vir meer inligting oor getTacoTranslateStaticProps.

Fouthantering en foutopsporing

Beste praktyke

Gebruik ARIA-labels

Globale oorspronge-array en meerdere komponent-oorspronge