概要

useLocale フックは、<GTProvider> のコンテキストからユーザーの現在の locale を取得します。 返される locale は文字列として整形され、例えば 'en-US' のようになります。

リファレンス

戻り値

ユーザーの現在のlocaleを表す文字列。例: 'en-US'。

フォールバックの動作

未対応のlocaleが要求された場合、フォールバック用のlocaleが選択されます。

たとえば未対応のlocaleで、 (1) ユーザーがブラウザー設定で複数の優先localeを設定しており、 かつ (2) そのうちの一つがアプリケーションでサポートされている場合、 localeは最適な言語にフォールバックします。

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

いずれの条件も満たせない場合は、デフォルトのlocaleが使用されます。

対応ロケールの設定方法については、<GTProvider>を参照してください。

例

基本的な使い方

現在のlocaleを取得して、コンポーネント内に表示します。

import { useLocale } from 'gt-react';

export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>現在のロケール: {locale}</p>;
}

注意事項

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

次のステップ

• アプリケーションで対応ロケールを管理・指定する方法については、gt.config.json ファイルをご覧ください。