useDefaultLocale()

概要

useDefaultLocale フックは、アプリケーションのデフォルトロケールを <GTProvider> コンテキスト から取得します。 このロケールはアプリのフォールバック言語を表し、通常はユーザーの希望するロケールが利用できない場合に使用されます。

設定については withGTConfig() を参照してください。 withGTConfig() でデフォルトロケールが指定されていない場合、デフォルトで 'en-US' になります。 サーバーサイドについては getDefaultLocale() を参照してください。

リファレンス

戻り値

アプリケーションのデフォルトロケールを表す文字列（例：'en-US'）です。

例

基本的な使用方法

アプリケーションのデフォルトロケールを取得し、コンポーネント内で表示します。

"use client";
import { useDefaultLocale } from 'gt-next';

export default function DefaultLocale() {
    const defaultLocale = useDefaultLocale();

    return <p>Default locale: {defaultLocale}</p>; // Display the default locale
}

注意

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

次のステップ

• ユーザーのロケールを取得するには、useLocale および getLocale をご覧ください。
• サーバーコンポーネントでデフォルトのロケールを取得するには、getDefaultLocale() をご確認ください。