useDict()

Übersicht

useDict() wird verwendet, um auf Zeichenkettenübersetzungen aus dem Übersetzungswörterbuch zuzugreifen. Es muss innerhalb einer Komponente verwendet werden, die von einem <GTProvider> umschlossen ist.

const d = useDict(); // Get the translation function
d('greeting.hello'); // pass the id to get a translation

Referenz

Parameter

Beschreibung

Rückgabewert

Eine Übersetzungsfunktion d(), die bei Angabe einer id die übersetzte Version des entsprechenden Eintrags zurückgibt

(id: string, options?: DictionaryTranslationOptions) => React.ReactNode

Beispiele

Grundlegende Verwendungen

Jeder Eintrag in deinem Wörterbuch wird übersetzt.

const dictionary = {
  greeting: "Hello, Bob", 
};
export default dictionary;

Wenn wir auf diese Einträge zugreifen möchten, rufen wir useDict() auf. Dies gibt eine Funktion zurück, die den Schlüssel einer Übersetzung aus dem Wörterbuch akzeptiert.

Du musst das Wörterbuch an die GTProvider Komponente übergeben.

import { useDict } from 'gt-react';
import dictionary from "./dictionary.json"

export default async function TranslateGreeting() {
  const d = useDict(); 
  return (
    <GTProvider dictionary={dictionary}>
      <p>
        {d('greeting')} // [!code highlight]
      </p>
    </GTProvider>
  );
}

Verwendung von Variablen

Um Werte zu übergeben, musst du (1) einen Bezeichner zuweisen und (2) den Bezeichner beim Aufruf der d() Funktion referenzieren.

In diesem Beispiel verwenden wir {} um Variablen an die Übersetzungen zu übergeben. Im Wörterbuch weisen wir den Bezeichner {userName} zu.

const dictionary = {
  greeting: "Hello, {userName}!", 
};
export default dictionary;

import { useDict } from 'gt-react';

export default async function TranslateGreeting() {
  const d = useDict();
  
  // Hello Alice!
  const greetingAlice = d('greeting', { userName: "Alice" }); 

  return (
    <p>
      {greetingAlice} // Hello, Alice // [!code highlight]
    </p>
  );
}

Verwendung von Präfixen

Wir können Präfixe verwenden, um nur einen Teil des Wörterbuchs zu übersetzen.

const dictionary = {
  prefix1: { 
    prefix2: { 
      greeting: "Hello, Bob",
    }
  }
};
export default dictionary;

Da wir den Wert 'prefix1.prefix2' an den useDict Hook übergeben haben, sind alle Schlüssel mit prefix1.prefix2 vorangestellt:

import { useDict } from 'gt-react';

export default function UserDetails() {
  const d = useDict('prefix1.prefix2'); 
  return (
    <div>
      <p>{d('greeting')}</p> // greeting => prefix1.prefix2.greeting // [!code highlight]
    </div>
  );
}

Hinweise

• Die Funktion useDict() ermöglicht den Zugriff auf Wörterbuchübersetzungen.
• Der Hook useDict() kann nur innerhalb einer Komponente verwendet werden, die von einer <GTProvider>-Komponente umschlossen ist.

Nächste Schritte

• Erfahren Sie mehr über die Verwendung von Dictionaries in der Dictionaries-Referenz.