Helpers

useDefaultLocale()

useDefaultLocale 钩子的 API 参考

概述

useDefaultLocale 钩子从 <GTProvider> 上下文中检索应用程序的默认语言环境。 此语言环境代表您的应用的备用语言,通常在用户的首选语言环境不可用时使用。

useDefaultLocale 是一个客户端钩子,只能用于客户端组件。 确保您的应用被包裹在一个 <GTProvider> 中。

请参阅 withGTConfig() 以进行配置。 如果在 withGTConfig() 中未指定默认语言环境,则默认为 'en-US'。 对于服务器端,请参阅 getDefaultLocale()

参考

返回值

一个表示应用程序默认语言环境的字符串,例如,'en-US'


示例

基本用法

获取应用程序的默认语言环境并在您的组件中显示。

DefaultLocale.jsx
"use client";
import { useDefaultLocale } from 'gt-next/client';
 
export default function DefaultLocale() {
    const defaultLocale = useDefaultLocale();
 
    return <p>Default locale: {defaultLocale}</p>; // Display the default locale
}

注意事项

  • useDefaultLocale() 钩子依赖于 <GTProvider> 来访问上下文。 确保您的应用在根级别用提供者包裹。
  • useDefaultLocale() 仅限于客户端使用。
  • 这里了解更多关于语言环境字符串的信息。

下一步

在本页面