Inline Translations

useGT

useGT 字符串翻译函数的 API 参考

概览

useGT 是一个在构建阶段用于翻译字符串的 hook。

const t = useGT();

<p>{  t('此文本将被翻译')  }</p>;

构建时翻译: useGT 的翻译在构建阶段执行,即应用部署之前。 虽然你可以向翻译后的字符串传入变量,但只能翻译在构建阶段可知的内容。

参考资料

参数

返回值

一个回调函数 t,用于翻译传入的内容。

(content: string, options?: InlineTranslationOptions) => string
名称类型描述
contentstring要翻译的字符串内容。
options?InlineTranslationOptions自定义 t 行为的翻译 options。

行为表现

生产环境

在持续交付(CD)流程中,任何位于 t 函数内的内容都会在应用部署前完成翻译。 这可确保所有 locale 的快速加载,但只能翻译构建时已知的内容。

生成后,译文会根据你的配置(1)存储在 CDN(内容分发网络)中,或(2)存储在应用的构建产物中。 随后,这些已翻译的内容会提供给你的用户。 如果未找到对应译文,将会使用 fallback,回退到原始内容。

请务必遵循此处的部署指南

开发环境

在开发过程中,t 函数会按需翻译内容。 这有助于快速预览应用在不同语言下的效果。 请记得在环境中添加 Dev API key 以启用该行为。

在开发环境进行按需翻译时,你可能会看到一定的延迟。 在生产构建中不会出现这种情况,除非内容被明确按需翻译, 即使用 tx<Tx>


示例

基本用法

可以使用 useGT 来翻译字符串。

import { useGT } from 'gt-next';

export default function TranslateGreeting() {
  const t = useGT();

  return (
    <p>
      {t('你好,Alice!')}
    </p>
  );
}

注意:“Alice”将按用户的首选语言进行翻译。

使用变量

你可以向字典的翻译传入变量。

import { useGT } from 'gt-next';

export default function TranslateGreeting() {
  const t = useGT();

  return (
    <p>
      {t('你好,{name}!', { name: 'Alice'  })}
    </p>
  );
}

注意:“Alice”不会被翻译成用户的首选语言,因为它是一个变量。

使用 ICU 消息格式

gt-next 支持 ICU 消息格式,可用于格式化变量。

import { useGT } from 'gt-next';

export default function TranslateGreeting() {
  const t = useGT();
  return (
    <p>
      {t('购物车中有 {count, plural, =0 {没有商品} =1 {一件商品} other {{count} 件商品}}', { count: 10 })}
    </p>
  );
}

ICU 消息格式是格式化变量的强大工具。 了解更多,请参阅 ICU 消息格式文档

gt-next/client 导入

如果在使用 "use client" 指令的环境中运行,应从 gt-next/client 导入,而不是从 gt-next 导入。

"use client";
import { useGT } from 'gt-next/client';

export default function TranslateGreeting() {
  const t = useGT();

  return (
    <p>
      {t('你好,Alice!')}
    </p>
  );
}

注意

  • useGT 函数是用于翻译字符串的 hook。
  • 使用 useGT 的字符串翻译会在构建阶段、运行时之前完成(开发环境除外)。

后续步骤

  • 请参阅 getGT,了解在构建时进行异步字符串翻译。
  • 如需在运行时进行翻译,请参阅 tx<Tx>

这份指南怎么样?

useGT