# gt-react: General Translation React SDK: useGT
URL: https://generaltranslation.com/ja/docs/react/api/strings/use-gt.mdx
---
title: useGT
description: useGT の文字列翻訳関数に関する API リファレンス
---

{/* 自動生成: 直接編集せず、代わりに content/docs-templates/ のテンプレートを編集してください。 */}


## 概要

`useGT` 関数は、ビルド時に文字列を翻訳するためのフックです。

```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` 関数は、文字列を翻訳するためのフックです。
* `useGT` による文字列の翻訳は、runtime より前のビルド時に行われます (開発 時を除く) 。