@k8ordo/i18n

Server ComponentでもClient Componentでも使えるReactの多言語対応

bash
npm install @k8ordo/i18n
src/i18n.ts
import { defineLocales } from '@k8ordo/i18n';

export const locales = defineLocales({
  ja: { timeZone: 'Asia/Tokyo', dir: 'ltr' },
  en: { timeZone: 'UTC', dir: 'ltr' },
});
src/messages/nav.ts
import { message } from '@k8ordo/i18n';

export const home = message({ ja: 'ホーム', en: 'Home' });
src/components/header.tsx
import { home } from '../messages/nav';

export function Header() {
  return (
    <header>
      <a href="/">{home()}</a>
    </header>
  );
}

プロバイダもフックも無い呼び出し

文言はただの関数で、呼ばれた場所でロケールを読みます。ブラウザではURLの先頭にあるロケール(/en/…のen)を、サーバーではlocales.runかlocales.paramsSchemaが設定したロケールを読みます。

言語を切り替えるときは、別のロケールのURL(/ja/…から/en/…)へ移動するだけです。

src/components/page-title.tsx
import { home } from '../messages/nav';

export function PageTitle() {
  return <h1>{home()}</h1>;
}
src/components/home-link.tsx
'use client';

import { home } from '../messages/nav';

export function HomeLink() {
  return <a href="/">{home()}</a>;
}

訳し忘れの型エラー

ロケールの型がRegisterに登録されていれば、messageはすべてのロケールの文を求めます。1つでも欠けていれば、その宣言が型エラーになります。

値を差し込む文言は、ロケールごとの関数として書きます。引数の型を1つのロケールに書いておけば、ほかのロケールも同じ型で検査されます。

src/messages/nav.ts
import { message } from '@k8ordo/i18n';

export const greeting = message({
  ja: (name: string) => `こんにちは、${name}さん`,
  en: (name) => `Hello, ${name}`,
});

export const save = message({ ja: '保存' });
`en`が無いので型エラーになる

使った文言だけのバンドル

messageの呼び出しには副作用が無いので、使われていない文言はバンドラが取り除きます。ブラウザに送られるのは、Client Componentが使っている文言だけです。

Server Componentが描画した文言は、ブラウザに送るコードを増やしません。辞書を名前空間に分けて読み込む設定もいりません。

src/components/greeting.tsx
'use client';

import { greeting } from '../messages/nav';

export function Greeting({ name }: { name: string }) {
  return <p>{greeting(name)}</p>;
}