Helpers
useDefaultLocale()
useDefaultLocale 钩子的 API 参考
概述
useDefaultLocale
钩子从 <GTProvider>
context 获取应用程序的默认语言环境。
该语言环境代表了应用的回退语言,通常在用户的首选语言不可用时使用。
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>
来访问上下文。 请确保你的应用在根级别包裹了 provider。useDefaultLocale()
仅限客户端使用。- 在这里了解更多关于 locale 字符串的信息。
后续步骤
- 查看
useLocale
和getLocale
以获取用户的语言环境。 - 了解
getDefaultLocale()
如何在服务端组件中获取默认语言环境。
这份指南怎么样?