useLocale()

概述

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

参考

返回值

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

回退行为

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

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

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

如果上述条件都无法满足，则会使用默认区域设置。

有关配置支持的区域设置的信息，请参阅 <GTProvider>。

示例

基本用法

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

import { useLocale } from 'gt-react';

export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>Current locale: {locale}</p>;
}

注意事项

• useLocale() 钩子依赖于 <GTProvider> 来访问上下文。 请确保你的应用在根节点被 provider 包裹。
• 在这里了解更多关于 locale 字符串的信息。

后续步骤

• 了解如何通过 gt.config.json 文件在你的应用中管理和指定支持的语言环境。
• 如需访问回退语言，请参阅 useDefaultLocale()。