概要

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が使用されます。

サポート対象のlocaleの設定については、<GTProvider> を参照してください。

例

基本的な使い方

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

import { useLocale } from 'gt-react';

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

注意事項

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

次のステップ

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