Overview

useTranslations is used to access string translations from the translation dictionary.

It must be used within a component wrapped by a <GTProvider>.

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

For async components, see getTranslations.

Reference

Parameters

Description

Returns

A translation function d that, given an ID, returns the translated version of the corresponding entry

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

Examples

Basic dictionary usage

Every entry in your dictionary is translated.

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

When we want to access these entries (on the client side), we call useTranslations. This returns a function that takes the key of a translation from the dictionary.

import { useTranslations } from 'gt-next';

export default async function TranslateGreeting() {
  const d = useTranslations(); 
  return (
    <p>
      {d('greeting')} // Hello, Alice // [!code highlight]
    </p>
  );
}

Using variables

To pass values, you must (1) assign an identifier and (2) reference that identifier when calling the d function.

In this example, we use {} to pass variables to the translations. In the dictionary, we assign the identifier {userName}.

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

import { useTranslations } from 'gt-next';

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

  return (
    <p>
      {greetingAlice}
    </p>
  );
}

Using prefixes

We can use prefixes to translate only a subset of the dictionary.

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

Because we’ve added the value 'prefix1.prefix2' to the useTranslations hook, all the keys are prefixed with prefix1.prefix2:

import { useTranslations } from 'gt-next';

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

Notes

• The useTranslations function lets you access dictionary translations on the client side.
• The useTranslations hook can only be used within a component wrapped by a <GTProvider> component.

Next steps

• For server-side translations, see getTranslations.
• Learn more about using dictionaries in the dictionaries reference.