useLocale()

概要

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

リファレンス

戻り値

ユーザーの現在のロケールを表す文字列、例: 'en-US'。

フォールバックの動作

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

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

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

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

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

例

基本的な使用法

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

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

メモ

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

次のステップ

• アプリケーションでサポートされているロケールを管理し、指定する方法については、ロケール管理を参照してください。
• フォールバック言語にアクセスするには、useDefaultLocale()を参照してください。