useGT
`useGT` 字符串翻译函数的 API 参考
概览
useGT 函数是一个在构建阶段用于翻译字符串的 Hook。
const t = useGT();
<p>{  t('此文本将被翻译')  }</p>;构建时翻译:
useGT 的翻译在构建阶段进行,先于应用部署。
虽然你可以向翻译后的字符串传入变量,但只能翻译在构建时已知的内容。
参考资料
参数
无
返回值
一个回调函数 t,用于翻译传入的内容。
(content: string, options?: InlineTranslationOptions) => string| 名称 | 类型 | 描述 | 
|---|---|---|
| content | string | 待翻译的字符串内容。 | 
| options? | InlineTranslationOptions | 用于自定义 t行为的翻译 options。 | 
行为
生产环境
在持续交付(CD)流程中,任何位于 t 函数内的内容都会在你的应用部署前完成翻译。
这可确保所有 locale 的快速加载,但只能翻译构建时已知的内容。
生成后,翻译将根据你的配置(1)存储在 CDN(内容分发网络)中,或(2)存储在你的应用构建产物中。 之后,这些已翻译的内容会被提供给你的用户。 如果未找到对应的翻译,将回退(fallback)到原始内容。
请务必遵循此处的部署指南。
开发环境
在开发过程中,t 函数会按需翻译内容。
这有助于快速搭建原型并预览应用在不同语言下的呈现效果。
请记得在环境中添加 Dev API key 以启用此功能。
在开发环境中进行按需翻译时,你可能会看到一些延迟。 在生产构建中则不会出现这种情况。
示例
基本用法
你可以使用 useGT 来翻译字符串。
import { useGT } from 'gt-react';
export default function TranslateGreeting() {
  const t = useGT();
  return (
    <p>
      {t('你好,Alice!')}
    </p>
  );
}注意:“Alice”将翻译为用户的首选语言。
使用变量
你可以向字典中的翻译传递变量。
import { useGT } from 'gt-react';
export default function TranslateGreeting() {
  const t = useGT();
  return (
    <p>
      {t('你好,{name}!', { name: 'Alice' })}
    </p>
  );
}注意:由于 “Alice” 是一个变量,它不会被翻译为用户的首选语言。
使用 ICU 消息格式
gt-react 支持 ICU 消息格式,可用于对变量进行格式化。
import { useGT } from 'gt-react';
export default function TranslateGreeting() {
  const t = useGT();
  return (
    <p>
      {t('购物车中有 {count, plural, =0 {没有商品} =1 {一件商品} other {{count} 件商品}}', { count: 10 })}
    </p>
  );
}ICU 消息格式是用于格式化变量的强大工具。 了解更多,请参见 ICU 消息格式文档。
注意事项
- useGT是用于翻译字符串的 hook。
- useGT只能在由- <GTProvider>组件 包裹的组件内使用。
- 使用 useGT的翻译会在运行时之前、即于构建阶段完成(开发环境除外)。
下一步
- 请参阅 useTranslations了解如何使用字典翻译字符串。
这份指南怎么样?

