useLocale()

概述

useLocale 钩子从 <GTProvider> 上下文中检索用户的当前语言环境。 返回的语言环境是格式化为字符串的，例如，'en-US'。

对于服务器端的语言环境管理，请参阅 getLocale()。

参考

返回值

一个表示用户当前语言环境的字符串，例如，'en-US'。

回退行为

当请求不支持的区域设置时，将选择一个回退区域设置。

例如，在不支持的区域设置的情况下， 如果 (1) 用户在其浏览器设置中配置了多个首选区域设置， 并且 (2) 这些区域设置之一被您的应用程序支持， 那么区域设置将回退到最佳语言。

此外，如果没有可用的回退区域设置， 但两个区域设置共享相同的语言（例如，en-US 和 en-GB）， 那么区域设置将回退到支持的共享相同语言的区域设置。

如果这两个条件都无法满足，则将使用默认区域设置。

有关配置支持的区域设置的信息，请参阅 区域设置管理指南()。

示例

基本用法

获取当前语言环境并在您的组件中显示。

"use client";
import { useLocale } from 'gt-next/client';
 
export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>当前语言环境: {locale}</p>;
}

注意事项

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

下一步

• 了解如何在您的应用程序中管理和指定支持的语言环境，请参阅语言环境管理。
• 要访问备用语言，请参阅useDefaultLocale()。