# gt-react: General Translation React SDK: useGT
URL: https://generaltranslation.com/zh/docs/react/api/strings/use-gt.mdx
---
title: useGT
description: useGT 字符串翻译函数的 API 参考文档
---

{/* 自动生成：请勿直接编辑。请改为编辑 content/docs-templates/ 中的 template。 */}


## 概述

`useGT` 函数是一个用于在构建阶段翻译字符串的 Hook。

```jsx
const gt = useGT();

<p>{gt('This text will be translated')}</p>;
```

<Callout>
  **构建时翻译：** `useGT` 的翻译在构建阶段完成，也就是在
  应用部署之前。虽然你可以向翻译后的字符串传入变量，但你
  只能翻译在构建阶段就已确定的内容。
</Callout>


## 参考

### 参数

无

### 返回值

回调函数 `gt`，用于翻译传入的内容。

```jsx
(content: string, options?: InlineTranslationOptions) => string
```

| 名称         | 类型                                                                             | 说明                   |
| ---------- | ------------------------------------------------------------------------------ | -------------------- |
| `content`  | `string`                                                                       | 要翻译的字符串内容。           |
| `options?` | [`InlineTranslationOptions`](/docs/react/api/types/inline-translation-options) | 用于自定义 `gt` 行为的翻译配置项。 |

***


## 行为

### 生产环境

在 CD 过程中，`gt` 函数中的任何内容都会在应用部署前完成翻译。
这样可以确保所有区域设置都有较快的加载速度，但它只能翻译在构建时已知的内容。

翻译生成后，会根据你的设置：(1) 存储在 CDN 中，或 (2) 存储在应用的构建产物中。
随后，这些翻译后的内容会被提供给用户。
如果找不到对应翻译，则会回退为原始内容。

请务必遵循[此部署指南](/docs/react/tutorials/quickdeploy)。

### 开发

在开发过程中，`gt` 函数会按需翻译内容。
这有助于你在原型开发时预览应用在不同语言下的显示效果。
请记得在环境中添加 Dev API キー，以启用此行为。

在开发环境中进行按需翻译时，你会看到一定延迟。
除非内容被明确配置为按需翻译，否则生产构建中不会出现这种情况。

***

## 示例

### 基本用法

你可以使用 `useGT` 翻译字符串。

```jsx copy
import { useGT } from 'gt-react';

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

  return <p>{gt('Hello, Alice!')}</p>;
}
```

注意：&quot;Alice&quot; 将被翻译成用户首选的语言。


### 使用变量 [#variables]

你可以在字典翻译中传入变量。

```jsx copy
import { useGT } from 'gt-react';

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

  return <p>{gt('Hello, {name}!', { name: 'Alice' })}</p>;
}
```

注意：&quot;Alice&quot; 不会被翻译成用户的首选语言，因为它是一个变量。


### 使用 ICU 消息格式

`gt-react` 支持 ICU 消息格式，因此你也可以对变量进行格式化。

```jsx copy
import { useGT } from 'gt-react';

export default function TranslateGreeting() {
  const gt = useGT();
  return (
    <p>
      {gt(
        'There are {count, plural, =0 {no items} =1 {one item} other {{count} items}} in the cart',
        { count: 10 }
      )}
    </p>
  );
}
```

<Callout>
  ICU 消息格式是一种功能强大的变量格式化方式。更多
  信息请参阅 [ICU 消息格式
  文档](https://unicode-org.github.io/icu/userguide/format_parse/messages/)。
</Callout>


### 从 `gt-react` 导入

如果使用 `"use client"` 指令，应从 `gt-react` 导入，而不是 `gt-react`。

```jsx copy
'use client';
import { useGT } from 'gt-react';

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

  return <p>{gt('Hello, Alice!')}</p>;
}
```

***


## 注意事项

* `useGT` 函数是一个用于翻译字符串的 Hook。
* 使用 `useGT` 翻译字符串会在 runtime 之前的构建过程中完成 (开发环境除外) 。