Helpers

getDefaultLocale

サーバーサイドメソッド getDefaultLocale の APIリファレンス

概要

getDefaultLocale 関数は、アプリケーションの既定のロケールを取得します。 このロケールはサーバー起動時に決定され、翻訳のフォールバック言語として使用されます。 返り値はロケール文字列(例: 'en-US')です。

getDefaultLocale はサーバーサイドのメソッドで、サーバーサイドのコンポーネントでのみ使用できます。

設定については withGTConfig を参照してください。 withGTConfig で既定のロケールが指定されていない場合は、既定で 'en-US' になります。 クライアントサイド向けは useDefaultLocale を参照してください。

リファレンス

戻り値

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


基本的な使い方

アプリケーションのデフォルトのlocaleを取得し、サーバーサイドのロジックで使用します。

GetDefaultLocale.jsx
import getDefaultLocale from 'gt-next/server';

export default function GetDefaultLocale() {
    const defaultLocale = getDefaultLocale(); 
    return <p>デフォルトのlocale: {defaultLocale}</p>;
}

注意事項

  • getDefaultLocale は、withGTConfig で設定された既定のロケールを返します。
  • getDefaultLocale はサーバーサイド専用です。
  • 返されるロケールは ロケールコード文字列 の形式に準拠します。

次のステップ

  • ユーザーのlocaleを取得する方法については、useLocalegetLocale を参照してください。

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

getDefaultLocale