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

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


## 概要

`useMessages` 関数は、`msg` でエンコードされた文字列をビルド時に翻訳するためのフックです。

```jsx
const m = useMessages();

<p>{m(encodedString)}</p>;
```

<Callout>
  **ビルド時翻訳:** `useMessages` の翻訳は、アプリのデプロイ前、
  ビルド時に実行されます。`msg` のエンコード済み文字列を渡すと、
  ユーザーの優先言語に翻訳されます。
</Callout>


## リファレンス

### パラメータ

なし

### 戻り値

`msg` によって生成されたエンコード済みコンテンツを翻訳するコールバック関数 `m`。

```jsx
(encodedContent: string, options?: Record<string, any>) => string
```

| 名前               | 型                     | 説明                                 |
| ---------------- | --------------------- | ---------------------------------- |
| `encodedContent` | `string`              | `msg` から渡される、翻訳対象のエンコード済み文字列コンテンツ。 |
| `options?`       | `Record<string, any>` | エンコード済み文字列に変数を渡すための省略可能なパラメータ。     |

***


## 動作

### 本番環境

CD プロセスでは、`msg` 関数内のコンテンツはすべて、アプリケーションのデプロイ前に翻訳されます。
これにより、すべてのロケールで高速に読み込めますが、翻訳できるのは ビルド時 に判明しているコンテンツに限られます。

生成された翻訳は、設定に応じて (1) CDN に保存されるか、(2) アプリのビルド出力に保存されます。
そこから、翻訳済みのコンテンツがユーザーに配信されます。
翻訳が見つからない場合は、元のコンテンツにフォールバックします。

必ず[こちらのデプロイガイド](/docs/react/tutorials/quickdeploy)に従ってください.

### 開発

開発中は、`m` 関数がコンテンツを on-demand で翻訳します。
これにより、アプリがさまざまな言語でどのように表示されるかを試作段階で確認できます。
この動作を有効にするには、環境に Dev API キーを追加してください。

開発時に on-demand 翻訳を行うと、遅延が発生します。
ただし、本番ビルドでは、コンテンツを明示的に on-demand で翻訳している場合を除き、これは発生しません。

***

## 例

### 基本的な使い方

`useMessages` を使うと、`msg` でエンコードした文字列を翻訳できます。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedGreeting = msg('Hello, Alice!');

export default function TranslateGreeting() {
  const m = useMessages();

  return <p>{m(encodedGreeting)}</p>;
}
```

注: &quot;Alice&quot; はユーザーが設定した優先言語に翻訳されます。


### 変数を使う [#variables]

エンコードされた文字列には変数を渡せます。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedGreeting = msg('Hello, {name}!');

export default function TranslateGreeting() {
  const m = useMessages();

  return (
    <p>
      {m(encodedGreeting, { name: 'Bob' })}{' '}
      {/* これは "Hello, Bob!" と表示されます */}
    </p>
  );
}
```


### `msg` の変数は `m` の変数より優先されます

`msg` と `m` の両方に変数を渡した場合は、`msg` に渡した変数が `m` に渡した変数より優先されます。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedGreeting = msg('Hello, {name}!', { name: 'Alice' });

export default function TranslateGreeting() {
  const m = useMessages();
  return <p>{m(encodedGreeting, { name: 'Bob' })}</p>;
}
```

注: これは &quot;Hello, Alice!&quot; と表示されます。変数はレンダリング時に上書きされません。


### ICU メッセージ形式の使用

`gt-react` は ICU メッセージ形式をサポートしており、変数の書式設定も行えます。

```jsx copy
import { msg, useMessages } from 'gt-react';

const encodedMessage = msg(
  'There are {count, plural, =0 {no items} =1 {one item} other {{count} items}} in the cart',
  { count: 10 }
);

export default function TranslateGreeting() {
  const m = useMessages();
  return <p>{m(encodedMessage)}</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 { msg, useMessages } from 'gt-react';

const encodedGreeting = msg('Hello, Alice!');

export default function TranslateGreeting() {
  const m = useMessages();

  return <p>{m(encodedGreeting)}</p>;
}
```

***


## 注記

* `useMessages` 関数は、`msg` によってエンコードされた文字列を翻訳するフックです。
* `useMessages` による文字列の翻訳は、runtime ではなくビルドプロセス中に行われます (開発時を除く) 。

## 次のステップ

* 文字列を翻訳用にエンコードする方法については、[`msg`](/docs/react/api/strings/msg)を参照してください。