Helpers

useDefaultLocale

useDefaultLocale 钩子的 API 参考

概览

useDefaultLocale 钩子会从 <GTProvider> 上下文中获取应用的默认 locale。 该 locale 表示应用的 fallback 语言,通常在用户的首选 locale 不可用时使用。

useDefaultLocale 是一个客户端钩子,且只能用于客户端组件。 请确保你的应用已由 <GTProvider> 包裹。

配置请参阅 withGTConfig。 如果在 withGTConfig 中未指定默认 locale,则默认使用 '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 仅限客户端使用。
  • 这里了解有关语言环境代码字符串的更多信息。

下一步

这份指南怎么样?

useDefaultLocale