このページとあなたの好きなAIアシスタントを使ってドキュメントを要約します
バージョン履歴
- "Solid の useIntlayer API の使用法を直接プロパティアクセスに更新"v8.9.02026/5/4
- "初期履歴"v8.4.102026/3/23
このページのコンテンツはAIを使用して翻訳されました。
英語の元のコンテンツの最新バージョンを見るIf you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.
GitHub link to the documentationCopy doc Markdown to clipboard
Intlayerを使用したViteおよびVanilla JSウェブサイトの翻訳 | 国際化 (i18n)
目次
Intlayerとは?
Intlayerは、現代的なウェブアプリケーションでの多言語サポートを簡素化するために設計された、革新的でオープンソースの国際化(i18n)ライブラリです。
Intlayerを使用すると、以下のことが可能です:
- コンポーネントレベルで宣言的な辞書を使用して翻訳を簡単に管理。
- メタデータ、ルート、およびコンテンツを動的にローカライズ。
- 自動生成された型によるTypeScriptサポートの確保。オートコンプリートとエラー検出が向上します。
- 動的な言語検出や切り替えなどの高度な機能の恩恵。
ViteおよびVanilla JSアプリケーションでIntlayerをセットアップするためのステップバイステップガイド
ステップ 1: 依存関係のインストール
npmを使用して必要なパッケージをインストールします:
コードをクリップボードにコピー
npm install intlayer vanilla-intlayernpm install vite-intlayer --save-devnpx intlayer initintlayer 設定管理、翻訳、コンテンツ宣言、トランスパイル、およびCLIコマンドのための国際化ツールを提供するコアパッケージ。
vanilla-intlayer Intlayerを純粋なJavaScript / TypeScriptアプリケーションと統合するパッケージ。パブリッシュ/サブスクライブ シングルトン (
IntlayerClient) とコールバックベースのヘルパー (useIntlayer、useLocaleなど) を提供し、UIフレームワークに依存せずにアプリのどこからでも言語の変更に反応できるようにします。vite-intlayer Intlayerを[Vite バンドラー](https://vite.dev/guide/why.html Japan#why-bundle-for-production)と統合するためのViteプラグイン、およびユーザーの優先言語の検出、クッキーの管理、URLリダイレクトの処理のためのミドルウェアが含まれています。
ステップ 2: プロジェクトの設定
アプリケーションの言語を設定するための設定ファイルを作成します。
コードをクリップボードにコピー
import { Locales, type IntlayerConfig } from "intlayer";
const config: IntlayerConfig = {
internationalization: {
locales: [
Locales.ENGLISH,
Locales.FRENCH,
Locales.SPANISH,
// その他の言語
],
defaultLocale: Locales.ENGLISH,
},
};
export default config;この設定ファイルを通じて、ローカライズされたURL、ミドルウェアのリダイレクト、クッキー名、コンテンツ宣言の場所と拡張子、コンソールでのIntlayerログの無効化などを設定できます。利用可能なパラメータの全リストについては、設定ドキュメントを参照してください。
ステップ 3: Vite設定へのIntlayerの統合
設定にintlayerプラグインを追加します。
コードをクリップボードにコピー
import { defineConfig } from "vite";
import { intlayer } from "vite-intlayer";
// https://vitejs.dev/config/
export default defineConfig({
plugins: [intlayer()],
});intlayer() Viteプラグインは、IntlayerをViteと統合するために使用されます。コンテンツ宣言ファイルの構築を確実にし、開発モードでそれらを監視します。Viteアプリケーション内でIntlayer環境変数を定義します。さらに、パフォーマンスを最適化するためのエイリアスを提供します。
ステップ 4: エントリーポイントでのIntlayerのブートストラップ
グローバルな言語シングルトンの準備ができるように、コンテンツがレンダリングされる前に installIntlayer() を呼び出します。
コードをクリップボードにコピー
import { installIntlayer } from "vanilla-intlayer";// i18nコンテンツをレンダリングする前に呼び出す必要があります。installIntlayer();// アプリケーションモジュールをインポートして実行。import "./app.js";md() コンテンツ宣言(Markdown)も使用する場合は、Markdownレンダラーもインストールしてください:
コードをクリップボードにコピー
import { installIntlayer, installIntlayerMarkdown } from "vanilla-intlayer";installIntlayer();installIntlayerMarkdown();import "./app.js";ステップ 5: コンテンツの宣言
翻訳を保存するためのコンテンツ宣言を作成および管理します。
コードをクリップボードにコピー
import { insert, t, type Dictionary } from "intlayer";
const appContent = {
key: "app",
content: {
title: "Vite + Vanilla",
viteLogoLabel: t({
en: "Vite Logo",
fr: "Logo Vite",
es: "Logo Vite",
}),
count: insert(
t({
en: "count is {{count}}",
fr: "le compte est {{count}}",
es: "el recuento es {{count}}",
})
),
readTheDocs: t({
en: "Click on the Vite logo to learn more",
fr: "Cliquez sur le logo Vite pour en savoir plus",
es: "Viteのロゴをクリックして詳細を確認してください",
}),
},
} satisfies Dictionary;
export default appContent;コンテンツ宣言は、
contentDirディレクトリ(デフォルトは./src)に含まれ、コンテンツ宣言のファイル拡張子(デフォルトは.content.{json,ts,tsx,js,jsx,mjs,cjs})に一致していれば、アプリケーション内のどこにでも定義できます。詳細については、コンテンツ宣言ドキュメントを参照してください。
ステップ 6: JavaScriptでのIntlayerの使用
vanilla-intlayer は react-intlayer のサーフェスAPIを反映しています:useIntlayer(key, locale?) は翻訳されたコンテンツを直接返します。結果に対して .onChange() をチェーンして言語の変更を購読します(これはReactの再レンダリングと同じ明示的な効果を持ちます)。
コードをクリップボードにコピー
import { installIntlayer, useIntlayer } from "vanilla-intlayer";installIntlayer();// 現在の言語の初期コンテンツを取得。// 言語が変更されるたびに通知を受け取るために .onChange() をチェーン。const content = useIntlayer("app").onChange((newContent) => { // 影響を受けるドームノードのみを再レンダリングまたはパッチ document.querySelector<HTMLHeadingElement>("h1")!.textContent = String( newContent.title ); document.querySelector<HTMLParagraphElement>(".read-the-docs")!.textContent = String(newContent.readTheDocs);});// 初期レンダリングdocument.querySelector<HTMLHeadingElement>("h1")!.textContent = String( content.title);document.querySelector<HTMLParagraphElement>(".read-the-docs")!.textContent = String(content.readTheDocs);リーフ値は
String()でラップして文字列としてアクセスします。これにより、ノードのtoString()メソッドが呼び出され、翻訳されたテキストを返します。ネイティブHTML属性の属性値(例:
alt、aria-label)が必要な場合は、.valueを直接使用してください。typescriptコードをコピーコードをクリップボードにコピー
img.alt = content.viteLogoLabel.value;
(任意) ステップ 7: コンテンツの言語を変更する
コンテンツの言語を変更するには、useLocale によって公開される setLocale 関数を使用します。
コードをクリップボードにコピー
import { getLocaleName } from "intlayer";import { useLocale } from "vanilla-intlayer";export function setupLocaleSwitcher(container: HTMLElement): () => void { const { locale, availableLocales, setLocale, subscribe } = useLocale(); const select = document.createElement("select"); select.setAttribute("aria-label", "Language"); const render = (currentLocale: string) => { select.innerHTML = availableLocales .map( (loc) => `<option value="${loc}"${loc === currentLocale ? " selected" : ""}> ${getLocaleName(loc)} </option>` ) .join(""); }; render(locale); container.appendChild(select); select.addEventListener("change", () => setLocale(select.value as any)); // 他の場所から言語が変更されたときにドロップダウンを同期させる return subscribe((newLocale) => render(newLocale));}(任意) ステップ 8: MarkdownおよびHTMLコンテンツのレンダリング
Intlayerは md() および html() コンテンツ宣言をサポートしています。Vanilla JSでは、コンパイルされた出力は innerHTML を介して生のHTMLとして挿入されます。
HTMLのコンパイルと注入:
コードをクリップボードにコピー
import { compileMarkdown, installIntlayerMarkdown, useIntlayer,} from "vanilla-intlayer";installIntlayerMarkdown();const content = useIntlayer("app").onChange((newContent) => { const el = document.querySelector<HTMLDivElement>(".edit-note")!; el.innerHTML = compileMarkdown(String(newContent.editNote));});document.querySelector<HTMLDivElement>(".edit-note")!.innerHTML = compileMarkdown(String(content.editNote));TIP String(content.editNote)は、生のMarkdown文字列を返すIntlayerNode上でtoString()を呼び出します。これをcompileMarkdownに渡してHTML文字列を取得し、innerHTMLを介して設定します。
WARNING 信頼できるコンテンツに対してのみ
innerHTMLを使用してください。Markdownがユーザー入力から来ている場合は、最初にサニタイズしてください(例:DOMPurifyを使用)。サニタイズレンダラーを動的にインストールできます:typescriptコードをコピーコードをクリップボードにコピー
import { installIntlayerMarkdownDynamic } from "vanilla-intlayer";await installIntlayerMarkdownDynamic(async () => { const DOMPurify = await import("dompurify"); return (markdown) => DOMPurify.sanitize(compileMarkdown(markdown));});
(任意) ステップ 9: アプリケーションへのローカライズされたルーティングの追加
言語ごとにユニークなルートを作成するには(SEOに有用)、Vite設定で intlayerProxy を使用してサーバーサイドの言語検出を行うことができます。
まず、Vite設定に intlayerProxy を追加します。
本番環境でintlayerProxyを使用するには、vite-intlayerをdevDependenciesからdependenciesに移動する必要があることに注意してください。
コードをクリップボードにコピー
import { defineConfig } from "vite";
import { intlayer, intlayerProxy } from "vite-intlayer";
export default defineConfig({
plugins: [
intlayerProxy(), // 最初に配置する必要があります
intlayer(),
],
});(任意) ステップ 10: 言語変更時のURL変更
言語が変更されたときにブラウザのURLを更新するには、Intlayerのインストール後に useRewriteURL() を呼び出します。
コードをクリップボードにコピー
import { installIntlayer, useRewriteURL } from "vanilla-intlayer";installIntlayer();// すぐに、およびその後のすべての言語変更時にURLを書き換えます。// クリーンアップのための購読停止関数を返します。const stopRewriteURL = useRewriteURL();(任意) ステップ 11: HTML 言語属性とテキスト方向属性の切り替え
アクセシビリティとSEOのために、<html> タグの lang および dir 属性を現在の言語に合わせて更新します。
コードをクリップボードにコピー
import { getHTMLTextDir } from "intlayer";import { installIntlayer, useLocale } from "vanilla-intlayer";installIntlayer();useLocale({ onLocaleChange: (locale) => { document.documentElement.lang = locale; document.documentElement.dir = getHTMLTextDir(locale); },});(任意) ステップ 12: 言語ごとの辞書の遅延ロード
大規模なアプリの場合、各言語の辞書を独自のチャンクに分割したい場合があります。Viteの動的 import() と併せて useDictionaryDynamic を使用します:
コードをクリップボードにコピー
import { installIntlayer, useDictionaryDynamic } from "vanilla-intlayer";installIntlayer();const unsubscribe = useDictionaryDynamic( { en: () => import("../.intlayer/dictionaries/en/app.mjs"), fr: () => import("../.intlayer/dictionaries/fr/app.mjs"), es: () => import("../.intlayer/dictionaries/es/app.mjs"), }, "app").onChange((content) => { document.querySelector("h1")!.textContent = String(content.title);});各言語のバンドルは、その言語がアクティブになったときにのみ取得され、結果はキャッシュされます。同じ言語へのその後の切り替えは瞬時に行われます。
(任意) ステップ 13: コンポーネントのコンテンツの抽出
既存のコードベースがある場合、数千のファイルを変換するのは時間がかかる場合があります。
このプロセスを容易にするために、Intlayerはコンポーネントを変換してコンテンツを抽出するための コンパイラ / エクストラクター を提案しています。
セットアップするには、intlayer.config.ts ファイルに compiler セクションを追加します。
コードをクリップボードにコピー
import { type IntlayerConfig } from "intlayer";const config: IntlayerConfig = { // ... その他の設定 compiler: { /** * コンパイラを有効にするかどうかを指定。 */ enabled: true, /** * 出力ファイルのパスを定義 */ output: ({ fileName, extension }) => `./${fileName}${extension}`, /** * 変換後にコンポーネントを保存するかどうかを指定。 * これにより、コンパイラを一度だけ実行してアプリを変換し、その後削除できます。 */ saveComponents: false, /** * 辞書キーの接頭辞 */ dictionaryKeyPrefix: "", },};export default config;エクストラクターを実行してコンポーネントを変換し、コンテンツを抽出します。
コードをクリップボードにコピー
npx intlayer extract(任意)サイトマップと robots.txt(ビルド時生成)
Intlayer は generateSitemap と getMultilingualUrls により、クローラ向けに整形した多言語の sitemap.xml と robots.txt を public/ に自動で書き出せます。通常は Vite より前に小さな Node スクリプトを走らせます(例: npm の predev / prebuild)。
サイトマップ
Intlayer のサイトマップ生成はロケール設定を踏まえ、クローラ向けのメタデータを含めます。
生成されるサイトマップはxhtml:link(hreflang)をサポートします。単純な URL 列挙ではなく、各ページの言語版同士を双方向で結びます(例:/about、/fr/about、/about?lang=frなどルーティングに依存)。
Robots.txt
getMultilingualUrls で Disallow を、機微パスのすべての言語 URLに効かせます。
1. プロジェクトルートに generate-seo.mjs を置く
コードをクリップボードにコピー
import fs from "fs";import path from "path";import { fileURLToPath } from "url";import { generateSitemap, getMultilingualUrls } from "intlayer";const __dirname = path.dirname(fileURLToPath(import.meta.url));const SITE_URL = (process.env.SITE_URL || "http://localhost:5173").replace( /\/$/, "");const pathList = [ { path: "/", changefreq: "daily", priority: 1.0 }, { path: "/about", changefreq: "monthly", priority: 0.7 },];const sitemapXml = generateSitemap(pathList, { siteUrl: SITE_URL });fs.writeFileSync(path.join(__dirname, "public", "sitemap.xml"), sitemapXml);const getAllMultilingualUrls = (urls) => urls.flatMap((url) => Object.values(getMultilingualUrls(url)));const disallowedPaths = getAllMultilingualUrls(["/admin", "/private"]);const robotsTxt = [ "User-agent: *", "Allow: /", ...disallowedPaths.map((path) => `Disallow: ${path}`), "", `Sitemap: ${SITE_URL}/sitemap.xml`,].join("\n");fs.writeFileSync(path.join(__dirname, "public", "robots.txt"), robotsTxt);console.log("SEO files generated successfully.");intlayer がインストールされている必要があります。本番では環境変数 SITE_URL を設定してください(CI など)。
Node の ESM ではgenerate-seo.mjsを推奨します。generate-seo.jsにする場合はpackage.jsonの"type": "module"などで ESM を有効にしてください。
2. Vite より前にスクリプトを実行する
コードをクリップボードにコピー
{ "scripts": { "dev": "vite", "prebuild": "node generate-seo.mjs", "build": "vite build", "preview": "vite preview" }}pnpm や yarn を使う場合はコマンドを読み替えてください。CI から呼び出しても構いません。
TypeScript の設定
TypeScript の設定に自動生成された型が含まれていることを確認してください。
コードをクリップボードにコピー
{ "compilerOptions": { // ... }, "include": ["src", ".intlayer/**/*.ts"],}Git 設定
Intlayer によって生成されたファイルは無視することをお勧めします。これにより、それらを Git リポジトリにコミットすることを避けることができます。
これを行うには、.gitignore ファイルに以下の指示を追加します。
コードをクリップボードにコピー
# Intlayer によって生成されたファイルを無視.intlayerVS Code 拡張機能
Intlayer での開発体験を向上させるために、公式の Intlayer VS Code 拡張機能 をインストールできます。
この拡張機能は以下の機能を提供します:
- 翻訳キーのオートコンプリート。
- 翻訳漏れのリアルタイムなエラー検出。
- 翻訳されたコンテンツのインライン形プレビュー。
- 翻訳を簡単に作成および更新できるクイックアクション。
拡張機能の使用方法の詳細については、Intlayer VS Code 拡張機能ドキュメントを参照してください。
次のステップ
さらに進むには、ビジュアルエディターを実装したり、CMSを使用してコンテンツを外部化したりできます。