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>默认 locale:{defaultLocale}</p>; // 显示默认 locale
}

注意事项

  • useDefaultLocale 钩子依赖 <GTProvider> 来访问上下文。 请确保你的应用在根级由 Provider 包裹。
  • useDefaultLocale 仅支持客户端。
  • 这里了解更多关于语言环境代码字符串的说明。

后续步骤

本指南如何?