Helpers

useDefaultLocale

useDefaultLocaleフックのAPIリファレンス

概要

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

useDefaultLocale はクライアントサイドのフックで、クライアントサイドのコンポーネントでのみ使用できます。 アプリ全体が <GTProvider> でラップされていることを確認してください。

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

リファレンス

返り値

アプリケーションのデフォルトの locale を表す文字列。例:'en-US'


基本的な使い方

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

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

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

    return <p>既定のロケール: {defaultLocale}</p>; // 既定のロケールを表示します
}

注意事項

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

次のステップ

  • ユーザーの locale を取得するには、useLocalegetLocale を参照してください。
  • サーバーコンポーネントで既定のロケールを取得する方法については、getDefaultLocale を参照してください。

このガイドはいかがですか?