概览

tx 函数是一个用于翻译字符串的服务器端函数。

await tx('Hello, world!'); // 返回 'Hola, mundo!'

参考资料

参数

返回值

一个 Promise，解析为包含翻译后内容的字符串；若无需翻译，则返回原始内容。

行为

tx 函数会在运行时翻译字符串。 这意味着翻译是即时进行的，因此你可以翻译仅在运行时才可知的内容。 权衡在于：等待按需翻译加载时会有延迟，速度会明显变慢。

我们的建议是尽可能在构建阶段使用 getGT、useGT 或 <T> 完成翻译， 仅在必要时才使用按需翻译，例如 tx 和 <Tx>。

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

示例

基本用法

你可以使用 tx 来翻译字符串。

import { tx } from 'gt-next/server';

export default async function translateGreeting() {
    return await tx("你好，世界！"); 
}

添加上下文

你可以通过提供翻译所需的上下文来定制译文效果。

import { tx } from 'gt-next/server';

export default async function TranslateWithOptions() {
    return await tx("你好，世界！", {
      $context: '非正式翻译'
    });
}

使用变量

要向字符串传递值，你需要 (1) 指定一个标识符，并 (2) 在传入的对象中引用该标识符。

import { tx } from 'gt-next/server';

export default async function translateWithVariables() {
  return await tx("价格为 {price, number, ::currency/USD}", {
    price: 29.99,
  });
}

指定 Locale

你可以指定用于翻译的 locale。 默认情况下，locale 会设为用户的首选语言。

import { tx } from 'gt-next/server';

export default async function translateWithLocale() {
    return await tx("Hello, world!", { $locale: 'fr' }); 
}

注意事项

• tx 仅用于服务器端，不能在客户端组件中使用。
• 使用 tx 的翻译在运行时执行，即实时翻译。这比构建时翻译慢得多。

后续步骤

• 请参阅 useGT 和 getGT 以在部署前进行字符串翻译。
• 如需翻译 JSX，请参阅 <T> 和 <Tx>。
• 有关自定义翻译的更多信息，请参阅 RuntimeTranslationOptions。