Helpers

useLocale

useLocale 钩子 API 参考

概览

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

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

参考资料

返回值

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


回退行为

当请求的是一个不受支持的 locale 时,系统会选择一个回退 locale。

例如,如果请求的 locale 不受支持, 且 (1) 用户在浏览器中配置了多个首选 locale, 并且 (2) 其中有某个 locale 为你的应用所支持, 则会回退到与之最匹配的语言。

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

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

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


示例

基本用法

获取当前 locale,并在组件中将其显示出来。

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

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

备注

  • useLocale 钩子依赖 <GTProvider> 提供的上下文。 请确保在应用的根层级包裹一个 provider。
  • 这里了解更多关于语言环境代码字符串的内容。

后续步骤

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

本指南如何?