@k8ordo/i18n

最初の言語

/はロケールを持たない唯一のURLです。訪問者の希望の言語からロケールを1つ選び、そのロケールのURLへ送れるようになります。

このページの内容

希望する言語からの選択

ts
locales.all; // ['ja', 'en', 'en-GB']

locales.negotiate(navigator.languages);

locales.negotiate(['en-GB']); // 'en-GB'
locales.negotiate(['en-US', 'ja']); // 'en'
locales.negotiate(['ja-JP', 'en']); // 'ja'
locales.negotiate(['***', 'en']); // 'en'
locales.negotiate(['fr', 'de']); // 'ja'

locales.negotiateは、訪問者が希望する言語のリストから、定義したロケールを1つ選びます。ブラウザなら、navigator.languagesをそのまま渡せます。

  1. 希望のタグを先頭から1つずつ見ます。
  2. そのタグと同じロケールを定義していれば、それを返します。大文字と小文字は区別しません。en-gbを渡すと、定義したとおりのen-GBが返ります。
  3. 無ければ、同じ言語のロケールのうち先に定義したものを返します。
  4. どちらも無ければ、次のタグへ進みます。BCP 47ではないタグはエラーにせず飛ばします。
  5. 最後まで一致しなければ、既定のロケールを返します。

リスト全体から同じタグを先に探すことはしません。['en-US', 'ja']を送る訪問者がいちばん読みたいのは英語です。enを定義していれば、2番目のjaが定義と同じタグでもenを返します。

情報

メモ

言語はIntl.Localeのlanguageだけで比べ、文字体系(script)や地域は比べません。zh-Hansとzh-Hantを定義していてzh-Hant-TWを渡すと、先に定義したzh-Hansが選ばれます。

Playground

言語の選択のデモ

このサイトのlocales(jaとen、既定はja)で、Accept-Languageヘッダーからロケールを選ぶデモです。

例
parseAcceptLanguageが返す並び
  1. fr-CH一致なし
  2. fr一致なし
  3. en-US同じ言語 → en
  4. ja見ない(すでに決まった)
negotiateの答え

en

試してみる

  1. 最初に入っているヘッダーでは、fr-CHとfrはどのロケールにも一致しません。en-USが言語でenに一致し、答えはenになります。
  2. en-US, jaを押します。答えはenのままで、jaは見ません。
  3. en_US, ja;q=0.5を押します。en_USはBCP 47ではないので飛ばされ、答えはjaになります。
  4. *;q=0.5, en;q=0, deを押します。*と重みが0のenはリストから除かれます。残ったdeも一致しないので、答えは既定のjaです。
  5. 「このブラウザのnavigator.languages」を押すと、このブラウザの言語の設定で選び直します。

Accept-Languageの読み取り

ts
import { parseAcceptLanguage } from '@k8ordo/i18n';

parseAcceptLanguage('en-US;q=0.8, ja, en;q=0.9');
// ['ja', 'en', 'en-US']

サーバーでは、リクエストのAccept-Languageヘッダーが訪問者の希望です。parseAcceptLanguageは、このヘッダーをnegotiateに渡せる配列に変換します。

  • qの重みが大きい順に並べます。qの無いタグの重みは1です。
  • 重みが同じタグは、ヘッダーに書かれた順を保ちます。
  • 重みが0以下のタグと*は除きます。どのタグも一致しなければ既定のロケールになるので、*は要りません。
  • 数値にならないqは無視し、重みを1のままにします。
  • ヘッダーが無い(null)ときと空白だけのときは、空の配列を返します。

タグそのものは確かめません。BCP 47ではないタグは、negotiateが飛ばします。

リクエストからの選択

ts
locales.negotiateRequest(request, { cookie: 'locale' });

negotiateRequestは、Requestからロケールを選びます。cookieにCookieの名前を渡すと、訪問者が前に選んだ言語をCookieから先に読み、次にAccept-Languageを読みます。

Cookieの値もヘッダーのリストも、同じnegotiateの規則で選びます。定義から消したロケールがCookieに残っていても、続くヘッダーで選び直します。cookieを省くと、ヘッダーだけを読みます。

Cookieを書く側は、言語の切り替えの「選んだ言語のCookie」を見てください。

サーバーでの/

src/lib/redirect-to-locale.ts
import { locales } from '../i18n';

export function redirectToLocale(request: Request): Response {
  const locale = locales.negotiateRequest(request, {
Cookie、次にAccept-Languageの順で選ぶ
    cookie: 'locale',
  });
  return new Response(null, {
    status: 307,
訪問者ごとに答えが変わるので307
    headers: { location: locales.localize('/', locale) },
  });
}

サーバーが/へのリクエストに応答できるなら、ページを描画せずにリダイレクトします。negotiateRequestでロケールを選び、そのロケールのURLへの307を返します。

localizeの結果にはViteのbaseが付きません。baseの下に置くアプリでは、移動先にする前に付けます。

@k8ordo/frameworkでは、serverモードならこの処理を/だけに答えるguard.tsに、staticモードなら次の節の処理を/のページに書きます。詳しくは@k8ordo/frameworkのルーティングを見てください。

ブラウザでの/

src/components/root-redirect.tsx
'use client';

import { useEffect } from 'react';

import { locales } from '../i18n';

export function RootRedirect() {
  useEffect(() => {
    const locale = locales.negotiate(navigator.languages);
    location.replace(locales.localize('/', locale));
  }, []);

  return null;
}

サーバーの無いサイトでは、/のページがブラウザでロケールを選びます。ページは何も描画せず、negotiateで選んだロケールのURLへ移動します。

  • 移動はuseEffectの中で行います。サーバーやビルドでの描画には、locationも訪問者のnavigator.languagesもありません。
  • location.replaceは履歴エントリを置き換えるので、戻るボタンで/に戻ってまた移動することがありません。
情報

メモ

JavaScriptが動かない訪問者は、/から先へ進めません。

src/components/root-redirect.tsx
useEffect(() => {
  void cookieStore.get('locale').then((saved) => {
    const locale = locales.negotiate([
      ...(saved?.value === undefined ? [] : [saved.value]),
      ...navigator.languages,
    ]);
    location.replace(locales.localize('/', locale));
  });
}, []);

選んだ言語をCookieに覚えているなら、その値をnavigator.languagesの前に並べてnegotiateに渡します。サーバーのnegotiateRequestが読むのと同じ順番です。

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。