Helpers
getDefaultLocale()
getDefaultLocale サーバーサイドメソッドのAPIリファレンス
概要
getDefaultLocale()
関数は、アプリケーションのデフォルトロケールを取得します。
このロケールはサーバー起動時に決定され、翻訳のフォールバック言語として使用されます。
ロケール文字列(例:'en-US'
)を返します。
getDefaultLocale()
はサーバーサイドのメソッドであり、サーバーサイドコンポーネントでのみ使用できます。
設定については、withGTConfig()
を参照してください。
withGTConfig()
でデフォルトロケールが指定されていない場合、'en-US'
がデフォルトとなります。
クライアントサイドについては、useDefaultLocale()
を参照してください。
リファレンス
戻り値
アプリケーションのデフォルトロケールを表す文字列(例:'en-US'
)。
例
基本的な使い方
アプリケーションのデフォルトロケールを取得し、サーバーサイドのロジックで使用します。
import getDefaultLocale from 'gt-next/server';
export default function GetDefaultLocale() {
const defaultLocale = getDefaultLocale();
return <p>Default locale: {defaultLocale}</p>;
}
注意事項
getDefaultLocale()
は、withGTConfig()
で設定されたデフォルトのロケールを返します。getDefaultLocale()
はサーバーサイド専用です。- 返されるロケールは、ロケール文字列の形式に準拠しています。
次のステップ
- ユーザーのロケールを取得するには、
useLocale()
およびgetLocale()
をご覧ください。 - クライアントコンポーネントでデフォルトのロケールを取得するには、
useDefaultLocale()
をご確認ください。
このガイドはいかがですか?