useLocale()

概要

useLocaleフックは、<GTProvider>コンテキストからユーザーの現在のロケールを取得します。 返されるロケールは文字列としてフォーマットされます（例：'en-US'）。

リファレンス

戻り値

ユーザーの現在のロケールを表す文字列（例：'en-US'）を返します。

フォールバック動作

サポートされていないロケールがリクエストされた場合、フォールバックロケールが選択されます。

例えば、サポートされていないロケールの場合に、 (1) ユーザーがブラウザ設定で複数の優先ロケールを設定していて、 (2) その中のいずれかのロケールがアプリケーションでサポートされている場合、 ロケールは最適な言語にフォールバックされます。

さらに、利用可能なフォールバックロケールが存在しない場合でも、 2つのロケールが同じ言語を共有している場合（例: en-US と en-GB）、 ロケールは同じ言語を共有するサポートされているロケールにフォールバックされます。

どちらの条件も満たされない場合は、デフォルトのロケールが使用されます。

サポートされているロケールの設定方法については、<GTProvider> を参照してください。

例

基本的な使い方

現在のロケールを取得し、コンポーネント内で表示します。

import { useLocale } from 'gt-react';

export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>Current locale: {locale}</p>;
}

Notes

• useLocale()フックは<GTProvider>に依存してコンテキストにアクセスします。 アプリがルートレベルでプロバイダーでラップされていることを確認してください。
• ロケール文字列について詳しくはこちらをご覧ください。

次のステップ

• gt.config.jsonファイルを使用してアプリケーションでサポートされるロケールを管理および指定する方法を学びます。
• フォールバック言語にアクセスするには、useDefaultLocale()を参照してください。