ダッシュボード

共有文字列

複数のコンポーネントやファイルで使われる文字列を国際化する方法

共有文字列は、アプリ全体の複数箇所で使われるテキスト値で、ナビゲーションのラベル、フォームメッセージ、設定データなどが該当します。各所で翻訳ロジックを重複させるのではなく、msg で文字列を翻訳対象としてマークし、useMessages でデコードします。

共有コンテンツの課題

アプリ全体で使われている次のナビゲーション設定を考えてみましょう。

// navData.ts
export const navData = [
  {
    label: 'ホーム',
    description: 'ホームページ',
    href: '/'
  },
  {
    label: 'About', 
    description: '会社について',
    href: '/about'
  }
];

これを国際化するには、通常は次の作業が必要です。

  1. 翻訳関数を受け取る関数に書き換える
  2. すべての使用箇所を t で関数呼び出しするように更新する
  3. コードベース全体で複雑さを管理する

これにより保守負荷が増え、コードの可読性も低下します。msg 関数は、翻訳対象の文字列をその場でマークし、必要なときにデコードできるようにすることで、これを解決します。

クイックスタート

文字列は msg でマークし、useMessages でデコードします。

// navData.ts - 翻訳用の文字列をマーク
import { msg } from 'gt-next';

export const navData = [
  {
    label: msg('ホーム'),
    description: msg('ホームページ'), 
    href: '/'
  },
  {
    label: msg('概要'),
    description: msg('会社に関する情報'),
    href: '/about'
  }
];
// コンポーネントの使用 - マークされた文字列をデコード
import { useMessages } from 'gt-next';
import { navData } from './navData';

function Navigation() {
  const m = useMessages();
  
  return (
    <nav>
      {navData.map((item) => (
        <a key={item.href} href={item.href} title={m(item.description)}>
          {m(item.label)}
        </a>
      ))}
    </nav>
  );
}

共有文字列の仕組み

共有文字列システムは2つのフェーズで動作します：

  1. マーキングフェーズ：msg が翻訳メタデータ付きで文字列をエンコードします
  2. デコードフェーズ：useMessages または getMessages が文字列をデコードして翻訳します
// msg() は文字列をメタデータと共にエンコードします
const encoded = msg('Hello, world!');
console.log(encoded); // "Hello, world!:eyIkX2hhc2giOiJkMjA3MDliZGExNjNlZmM2In0="

// useMessages() はデコードして翻訳します
const m = useMessages();
const translated = m(encoded); // ユーザーの言語での "Hello, world!"

msg が返す encoded string はそのままでは使用できません。必ず useMessages か getMessages でデコードしてください。

クライアントとサーバーの使い方の違い

クライアントコンポーネント

useMessages フックを使います:

import { useMessages } from 'gt-next';

const encodedString = msg('こんにちは、世界！');

function MyComponent() {
  const m = useMessages();
  return <div>{m(encodedString)}</div>;
}

サーバーコンポーネント

getMessages 関数を使用します:

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

const encodedString = msg('こんにちは、世界！');

async function MyServerComponent() {
  const m = await getMessages();
  return <div>{m(encodedString)}</div>;
}

decodeMsg を使って元の文字列を取得する

ログ出力、デバッグ、比較などの目的で、翻訳せずに元の文字列にアクセスしたい場合があります。元のテキストを取り出すには、decodeMsg を使用します。

import { decodeMsg } from 'gt-next';

const encoded = msg('Hello, world!');
const original = decodeMsg(encoded); // "Hello, world!" (元の文字列)
const translated = m(encoded); // "Hello, world!" (ユーザーの言語で)

// ログ出力やデバッグに便利
console.log('Original string:', decodeMsg(encoded));
console.log('Translated string:', m(encoded));

decodeMsg のユースケース

  • 開発・デバッグ: トラブルシューティングのために元の文字列をログ出力する
  • フォールバック処理: 翻訳に失敗した場合は元のテキストを使用する
  • 文字列比較: 既知の元の値と照合する
  • アナリティクス: 元の文字列の使用状況を計測する
// 例: フォールバック処理
function getDisplayText(encodedStr) {
  const m = useMessages();
  try {
    return m(encodedStr);
  } catch (error) {
    console.warn('翻訳に失敗しました。元のテキストを使用します:', decodeMsg(encodedStr));
    return decodeMsg(encodedStr);
  }
}

variables の使用

動的な内容を含む文字列には、プレースホルダーを使用し、variables を渡します:

// 変数を含む文字列をマーク
const items = 100;
export const pricing = [
  {
    name: 'Basic',
    price: 100,
    description: msg('ベーシックプランには{items}個のアイテムが含まれます', { items })
  }
];
// コンポーネントで使用
function PricingCard() {
  const m = useMessages();
  
  return (
    <div>
      <h3>{pricing[0].name}</h3>
      <p>{m(pricing[0].description)}</p>
    </div>
  );
}

ICUメッセージ形式

高度なフォーマットが必要な場合は、ICU の構文を使用します。

const count = 10;
const message = msg('カートに{count, plural, =0 {商品がありません} =1 {商品が1つあります} other {{count}個の商品があります}}', { count });

ICU message format の詳細は、Unicode のドキュメントをご覧ください。

例

ナビゲーション設定

// config/navigation.ts
import { msg } from 'gt-next';

export const mainNav = [
  {
    label: msg('ホーム'),
    href: '/',
    icon: 'home'
  },
  {
    label: msg('製品'),
    href: '/products', 
    icon: 'package'
  },
  {
    label: msg('会社概要'),
    href: '/about',
    icon: 'info'
  }
];

export const footerLinks = [
  {
    title: msg('会社情報'),
    links: [
      { label: msg('会社概要'), href: '/about' },
      { label: msg('採用情報'), href: '/careers' },
      { label: msg('お問い合わせ'), href: '/contact' }
    ]
  },
  {
    title: msg('サポート'), 
    links: [
      { label: msg('ヘルプセンター'), href: '/help' },
      { label: msg('ドキュメント'), href: '/docs' },
      { label: msg('APIリファレンス'), href: '/api' }
    ]
  }
];
// components/Navigation.tsx
import { useMessages } from 'gt-next';
import { mainNav } from '../config/navigation';

function Navigation() {
  const m = useMessages();
  
  return (
    <nav>
      {mainNav.map((item) => (
        <a key={item.href} href={item.href}>
          <Icon name={item.icon} />
          {m(item.label)}
        </a>
      ))}
    </nav>
  );
}

フォーム設定

// config/forms.ts
import { msg } from 'gt-next';

export const formMessages = {
  placeholders: {
    email: msg('メールアドレスを入力'),
    password: msg('パスワードを入力'),
    message: msg('メッセージを入力してください...')
  },
  actions: {
    send: msg('送信'),
    save: msg('保存'),
    cancel: msg('キャンセル')
  },
  validation: {
    required: msg('必須項目です'),
    email: msg('正しいメールアドレスを入力してください'),
    minLength: msg('{min}文字以上で入力してください', { min: 8 }),
    maxLength: msg('{max}文字以内で入力してください', { max: 100 })
  },
  success: {
    saved: msg('保存しました'),
    sent: msg('送信しました'),
    updated: msg('更新しました')
  },
  errors: {
    network: msg('ネットワークエラーが発生しました。再度お試しください'),
    server: msg('サーバーエラーが発生しました。サポートまでお問い合わせください'),
    timeout: msg('タイムアウトしました。再度お試しください')
  }
};
// components/ContactForm.tsx
import { useMessages } from 'gt-next';
import { formMessages } from '../config/forms';

function ContactForm() {
  const m = useMessages();
  const [errors, setErrors] = useState({});
  
  return (
    <form>
      <input 
        type="email"
        placeholder={m(formMessages.placeholders.email)}
        required
      />
      {errors.email && <span>{m(formMessages.validation.email)}</span>}
      
      <button type="submit">
        {m(formMessages.actions.send)}
      </button>
    </form>
  );
}

動的コンテンツの生成

// utils/productData.ts
import { msg } from 'gt-next';

function mockProducts() {
  return [
    { name: 'iPhone 15', company: 'Apple', category: 'エレクトロニクス' },
    { name: 'Galaxy S24', company: 'Samsung', category: 'エレクトロニクス' }
  ];
}

export function getProductData() {
  const products = mockProducts();
  
  return products.map(product => ({
    ...product,
    description: msg('{name}は{company}の{category}製品です', {
      name: product.name,
      category: product.category,
      company: product.company
    })
  }));
}
// components/ProductList.tsx
import { useMessages } from 'gt-next';
import { getProductData } from '../utils/productData';

function ProductList() {
  const m = useMessages();
  const products = getProductData();
  
  return (
    <div>
      {products.map(product => (
        <div key={product.name}>
          <h3>{product.name}</h3>
          <p>{m(product.description)}</p>
        </div>
      ))}
    </div>
  );
}

よくある問題

Encoded String を直接使う

msg の出力をそのまま使わないでください:

// ❌ 間違い - encoded stringを直接使用
const encoded = msg('Hello, world!');
return <div>{encoded}</div>; // 翻訳ではなくencoded stringが表示される

// ✅ 正しい - 最初に文字列をデコードする  
const encoded = msg('Hello, world!');
const m = useMessages();
return <div>{m(encoded)}</div>; // 適切な翻訳が表示される

msg() の動的コンテンツ

文字列はビルド時に判明している必要があります:

// ❌ 間違い - 動的テンプレートリテラル
const name = 'John';
const message = msg(`Hello, ${name}`); // ビルド時エラー

// ✅ 正しい - variablesを使用  
const name = 'John';
const message = msg('Hello, {name}', { name });

デコードのし忘れ

すべての msg 文字列はデコードが必要です。

// ❌ デコードが不足
const config = {
  title: msg('Dashboard'),
  subtitle: msg('Welcome back')
};

// コンポーネント内で後に - デコードを忘れた
return <h1>{config.title}</h1>; // エンコードされた文字列が表示される

// ✅ 正しい - 使用時にデコード
const m = useMessages();
return <h1>{m(config.title)}</h1>; // 翻訳されたタイトルが表示される

次のステップ

このガイドはどうでしたか？

文字列

useGT と getGT を使ってプレーンテキストの文字列を国際化する方法

動的コンテンツ

サーバーサイド翻訳APIで実行時コンテンツを翻訳する方法

このページについて

共有コンテンツの課題
クイックスタート
共有文字列の仕組み
クライアントとサーバーの使い方の違い
クライアントコンポーネント
サーバーコンポーネント
decodeMsg を使って元の文字列を取得する
decodeMsg のユースケース
variables の使用
ICUメッセージ形式
例
ナビゲーション設定
フォーム設定
動的コンテンツの生成
よくある問題
Encoded String を直接使う
msg() の動的コンテンツ
デコードのし忘れ
次のステップ
共有文字列