Helpers

useLocale

useLocale 钩子的 API 参考

概述

useLocale 钩子会从<GTProvider> 上下文中获取用户当前的 locale。 返回的 locale 为字符串格式,例如:'en-US'

请确保你的应用已由<GTProvider>包裹。

参考资料

返回值

表示用户当前 locale 的字符串,例如:'en-US'


回退行为

当请求不受支持的 locale 时,将选择一个回退 locale。

例如,在出现不受支持的 locale 时, 如果 (1) 用户在浏览器设置中配置了多个首选 locale, 并且 (2) 其中有一个 locale 受你的应用支持, 则 locale 将回退到最合适的语言。

另外,如果没有可用的回退 locale, 但有两个 locale 使用同一种语言(例如 en-USen-GB), 则 locale 将回退到共享该语言的受支持 locale。

如果上述条件均不满足,则会使用默认 locale。

有关配置受支持 locales 的信息,请参见 <GTProvider>


示例

基本用法

获取当前 locale,并在组件中显示。

CurrentLocale.jsx
import { useLocale } from 'gt-react';

export default function CurrentLocale() {
    const locale = useLocale(); 
    return <p>当前语言环境:{locale}</p>;
}

注意事项

  • useLocale hook 依赖 <GTProvider> 获取上下文。 请确保你的应用在根层由提供器包裹。
  • 这里了解更多关于语言环境代码字符串的信息。

后续步骤

  • 了解如何通过 gt.config.json 文件在你的应用中管理和指定支持的 locale。

这份指南怎么样?

useLocale