useDict()

Overview

useDict() is used to access string translations from the translation dictionary for client-side components. It must be used within a component wrapped by a <GTProvider>.

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

For server-side translations, see getDict().

Reference

Parameters

Description

Returns

A translation function d() that, given an id, will return the translated version of the corresponding entry

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

Examples

Basic Usages

Every entry in your dictionary gets translated.

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

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

"use client";
import { useDict } from 'gt-next/client';
 
export default async function TranslateGreeting() {
  const d = useDict(); 
  return (
    <p>
      {d('greeting')} // Hello, Alice
    </p>
  );
}

Using variables

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

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

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

"use client";
import { useDict } from 'gt-next/client';
 
export default async function TranslateGreeting() {
  const d = useDict();
  
  // Hello Alice!
  const greetingAlice = d('greeting', { userName: "Alice" }); 
 
  return (
    <p>
      {greetingAlice}
    </p>
  );
}

Using prefixes

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

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

Because we added the value 'prefix1.prefix2' to the useDict hook, all of the keys are prefixed with prefix1.prefix2:

"use client";
import { useDict } from 'gt-next/client';
 
export default function UserDetails() {
  const d = useDict('prefix1.prefix2'); 
  return (
    <div>
      <p>{d('greeting')}</p> // greeting => prefix1.prefix2.greeting
    </div>
  );
}

Notes

• The useDict() function allows you to access dictionary translations on the client side.
• The useDict() hook can only be used within a component wrapped by a <GTProvider> component.

Next Steps

• For server-side translations, see getDict().
• Learn more about using dictionaries in the dictionaries reference.
• See DictionaryTranslationOptions for more information on translation options.