Helpers

useDefaultLocale

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

概要

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

アプリを <GTProvider> でラップしていることを確認してください。

設定方法は <GTProvider> を参照してください。 既定のロケールが指定されていない場合は 'en-US' が使用されます。

リファレンス

戻り値

アプリケーションの既定のlocaleを表す文字列(例: 'en-US')。


基本的な使い方

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

DefaultLocale.jsx
import { useDefaultLocale } from 'gt-react';

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

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

注意事項

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

次の手順

このガイドはどうでしたか?

useDefaultLocale