Intlayerの今後のリリースに関する通知を受け取る
    作成:2024-12-06最終更新:2025-06-29

    Intlayer と Next.js 14 の App Router を使った国際化（i18n）入門

    GitHub の アプリケーションテンプレート をご覧ください。

    Intlayer とは？

    Intlayer は、最新のウェブアプリケーションにおける多言語対応を簡素化するために設計された革新的なオープンソースの国際化（i18n）ライブラリです。Intlayer は、強力な App Router を含む最新の Next.js 14 フレームワークとシームレスに統合されます。効率的なレンダリングのために Server Components と連携するよう最適化されており、Turbopack（Next.js 15 以降）にも完全対応しています。

    Intlayer を使うことで、以下が可能になります：

    • コンポーネントレベルで宣言的な辞書を使い、翻訳を簡単に管理できます。
    • メタデータ、ルート、コンテンツを動的にローカライズできます。
    • クライアントサイドおよびサーバーサイドの両方のコンポーネントで翻訳にアクセスできます。
    • 自動生成された型によるTypeScriptサポートを保証し、オートコンプリートやエラー検出を向上させます。
    • 動的なロケール検出や切り替えなどの高度な機能を活用できます。

    IntlayerはNext.js 12、13、14、15に対応しています。Next.jsのPage Routerを使用している場合は、このガイドを参照してください。Next.js 15（turbopackの有無にかかわらず）については、このガイドを参照してください。

    Next.jsアプリケーションでIntlayerをセットアップするステップバイステップガイド

    ステップ1：依存関係のインストール

    npmを使って必要なパッケージをインストールします：

    bash
    npm install intlayer next-intlayer

    • intlayer

      設定管理、翻訳、コンテンツ宣言、トランスパイル、およびCLIコマンドのための国際化ツールを提供するコアパッケージです。

    • next-intlayer

    IntlayerをNext.jsと統合するパッケージです。Next.jsの国際化のためのコンテキストプロバイダーやフックを提供します。さらに、IntlayerをWebpackやTurbopackと統合するためのNext.jsプラグイン、およびユーザーの優先ロケールの検出、クッキー管理、URLリダイレクトの処理を行うミドルウェアも含まれています。

    ステップ2: プロジェクトの設定

    アプリケーションの言語を設定するための設定ファイルを作成します：

    intlayer.config.ts
    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: Next.js設定にIntlayerを統合する

    Next.jsのセットアップをIntlayerを使うように設定します:

    next.config.mjs
    import { withIntlayer } from "next-intlayer/server";/** @type {import('next').NextConfig} */const nextConfig = {};export default withIntlayer(nextConfig);

    withIntlayer() は Next.js と Intlayer を統合するための Next.js プラグインです。これにより、コンテンツ宣言ファイルのビルドが保証され、開発モードでの監視が行われます。また、Webpack や Turbopack 環境内で Intlayer の環境変数を定義します。さらに、パフォーマンスを最適化するためのエイリアスを提供し、サーバーコンポーネントとの互換性も確保します。

    ステップ4: ロケール検出のためのミドルウェアを設定する

    ユーザーの好みのロケールを検出するためのミドルウェアを設定します:

    src/middleware.ts
    export { intlayerMiddleware as middleware } from "next-intlayer/middleware";export const config = {  matcher:    "/((?!api|static|assets|robots|sitemap|sw|service-worker|manifest|.*\\..*|_next).*)",};

    intlayerMiddleware は、ユーザーの優先ロケールを検出し、設定で指定された適切なURLにリダイレクトするために使用されます。さらに、ユーザーの優先ロケールをクッキーに保存することも可能にします。

    matcher パラメータは、アプリケーションのルートに合わせて調整してください。詳細については、Next.js の matcher 設定に関するドキュメントを参照してください。

    ステップ5: 動的ロケールルートの定義

    RootLayout の内容をすべて削除し、以下のコードに置き換えます。

    src/app/layout.tsx
    import type { PropsWithChildren, FC } from "react";import "./globals.css";const RootLayout: FC<PropsWithChildren> = ({ children }) => children;export default RootLayout;

    RootLayout コンポーネントを空にしておくことで、<html> タグに lang および dir 属性を設定できるようになります。

    動的ルーティングを実装するには、[locale] ディレクトリに新しいレイアウトを追加してロケールのパスを提供します。

    src/app/[locale]/layout.tsx
    import type { Next14LayoutIntlayer } from "next-intlayer";import { Inter } from "next/font/google";import { getHTMLTextDir } from "intlayer";const inter = Inter({ subsets: ["latin"] });const LocaleLayout: Next14LayoutIntlayer = ({  children,  params: { locale },}) => (  <html lang={locale} dir={getHTMLTextDir(locale)}>    <body className={inter.className}>{children}</body>  </html>);export default LocaleLayout;

    [locale] パスセグメントはロケールを定義するために使用されます。例：/en-US/about は en-US を指し、/fr/about は fr を指します。

    この段階で、Error: Missing <html> and <body> tags in the root layout. というエラーが発生します。これは予期されたもので、/app/page.tsx ファイルはもはや使用されておらず、削除して問題ありません。代わりに、[locale] パスセグメントが /app/[locale]/page.tsx ページを有効にします。その結果、ブラウザ上で /en、/fr、/es のようなパスでページにアクセスできるようになります。デフォルトのロケールをルートページとして設定するには、ステップ4の middleware 設定を参照してください。

    次に、アプリケーションの Layout に generateStaticParams 関数を実装します。

    src/app/[locale]/layout.tsx
    export { generateStaticParams } from "next-intlayer"; // 挿入する行const LocaleLayout: Next14LayoutIntlayer = ({  children,  params: { locale },}) => {  /*... 残りのコード */};export default LocaleLayout;

    generateStaticParams は、アプリケーションがすべてのロケールに対して必要なページを事前にビルドすることを保証し、実行時の計算を削減し、ユーザーエクスペリエンスを向上させます。詳細については、Next.js の generateStaticParams に関するドキュメントを参照してください。

    ステップ6: コンテンツの宣言

    翻訳を格納するためのコンテンツ宣言を作成および管理します:

    src/app/[locale]/page.content.ts
    import { t, type Dictionary } from "intlayer";const pageContent = {  key: "page",  content: {    getStarted: {      main: t({        en: "Get started by editing",        fr: "Commencez par éditer",        es: "Comience por editar",      }),      pageLink: "src/app/page.tsx",    },  },} satisfies Dictionary;export default pageContent;

    あなたのコンテンツ宣言は、contentDir ディレクトリ（デフォルトは ./src）に含まれている限り、アプリケーションのどこにでも定義できます。また、コンテンツ宣言ファイルの拡張子（デフォルトは .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}）に一致する必要があります。

    詳細については、コンテンツ宣言のドキュメントを参照してください。

    ステップ7: コード内でコンテンツを利用する

    アプリケーション全体でコンテンツ辞書にアクセスします:

    src/app/[locale]/page.tsx
    import { ClientComponentExample } from "@components/ClientComponentExample";import { ServerComponentExample } from "@components/ServerComponentExample";import { type Next14PageIntlayer, IntlayerClientProvider } from "next-intlayer";import { IntlayerServerProvider, useIntlayer } from "next-intlayer/server";const Page: Next14PageIntlayer = ({ params: { locale } }) => {  const content = useIntlayer("page", locale);  return (    <>      <p>        {content.getStarted.main}        <code>{content.getStarted.pageLink}</code>      </p>      <IntlayerServerProvider locale={locale}>        <IntlayerClientProvider locale={locale}>          <ServerComponentExample />          <ClientComponentExample />        </IntlayerClientProvider>      </IntlayerServerProvider>    </>  );};export default Page;
    • IntlayerClientProvider はクライアントサイドのコンポーネントにロケールを提供するために使用されます。これはレイアウトを含む任意の親コンポーネントに配置できます。ただし、Next.jsがページ間でレイアウトコードを共有するため、レイアウトに配置することが推奨されます。レイアウトで IntlayerClientProvider を使用することで、ページごとに再初期化する必要がなくなり、パフォーマンスが向上し、アプリケーション全体で一貫したローカリゼーションコンテキストを維持できます。
    • IntlayerServerProvider はサーバー側の子コンポーネントにロケールを提供するために使用されます。これはレイアウトには設定できません。

    レイアウトとページは共通のサーバーコンテキストを共有できません。なぜなら、サーバーコンテキストシステムはリクエストごとのデータストア（Reactのキャッシュメカニズムを通じて）に基づいており、アプリケーションの異なるセグメントごとに「コンテキスト」が再作成されるためです。プロバイダーを共有レイアウトに配置すると、この分離が破られ、サーバーコンポーネントへのサーバーコンテキスト値の正しい伝播が妨げられます。

    src/components/ClientComponentExample.tsx
    "use client";import type { FC } from "react";import { useIntlayer } from "next-intlayer";const ClientComponentExample: FC = () => {  const content = useIntlayer("client-component-example"); // 関連コンテンツ宣言を作成  return (    <div>      <h2>{content.title}</h2>      <p>{content.content}</p>    </div>  );};
    src/components/ServerComponentExample.tsx
    import type { FC } from "react";import { useIntlayer } from "next-intlayer/server";const ServerComponentExample: FC = () => {  const content = useIntlayer("server-component-example"); // 関連コンテンツ宣言を作成  return (    <div>      <h2>{content.title}</h2>      <p>{content.content}</p>    </div>  );};

    コンテンツを alt、title、href、aria-label などの string 属性で使用したい場合は、関数の値を呼び出す必要があります。例えば：

    jsx
    <img src={content.image.src.value} alt={content.image.value} />

    useIntlayer フックの詳細については、ドキュメントを参照してください。

    （オプション）ステップ8：メタデータの国際化

    ページのタイトルなどのメタデータを国際化したい場合は、Next.js が提供する generateMetadata 関数を使用できます。その中で、getIntlayer 関数からコンテンツを取得してメタデータを翻訳できます。

    src/app/[locale]/metadata.content.ts
    import { type Dictionary, t } from "intlayer";import { Metadata } from "next";const metadataContent = {  key: "page-metadata",  content: {    title: t({      en: "Create Next App",      fr: "Créer une application Next.js",      es: "Crear una aplicación Next.js",    }),    description: t({      en: "Generated by create next app",      fr: "Généré par create next app",      es: "Generado por create next app",    }),  },} satisfies Dictionary<Metadata>;export default metadataContent;
    src/app/[locale]/layout.tsx or src/app/[locale]/page.tsx
    import { getIntlayer, getMultilingualUrls } from "intlayer";import type { Metadata } from "next";import type { LocalParams } from "next-intlayer";export const generateMetadata = ({  params: { locale },}: LocalParams): Metadata => {  const metadata = getIntlayer("page-metadata", locale);  /**   * 各ロケールのすべてのURLを含むオブジェクトを生成します。   *   * 例:   * ```ts   *  getMultilingualUrls('/about');   *   *  // 戻り値   *  // {   *  //   en: '/about',   *  //   fr: '/fr/about',   *  //   es: '/es/about',   *  // }   * ```   */  const multilingualUrls = getMultilingualUrls("/");  return {    ...metadata,    alternates: {      canonical: multilingualUrls[locale as keyof typeof multilingualUrls],      languages: { ...multilingualUrls, "x-default": "/" },    },    openGraph: {      url: multilingualUrls[locale],    },  };};javascript fileName="src/app/[locale]/layout.mjs or src/app/[locale]/page.mjs" codeFormat="esm"import { getIntlayer, getMultilingualUrls } from "intlayer";export const generateMetadata = ({ params: { locale } }) => {  const metadata = getIntlayer("page-metadata", locale);  /**   * 各ロケールのすべてのURLを含むオブジェクトを生成します。   *   * 例:   * ```ts   *  getMultilingualUrls('/about');   *   *  // 戻り値   *  // {   *  //   en: '/about',   *  //   fr: '/fr/about',   *  //   es: '/es/about'   *  // }   * ```   */  const multilingualUrls = getMultilingualUrls("/");  return {    ...metadata,    alternates: {      canonical: multilingualUrls[locale],      languages: { ...multilingualUrls, "x-default": "/" },    },    openGraph: {      url: multilingualUrls[locale],    },  };};// ... 残りのコード

    next-intlayer からインポートされる getIntlayer 関数は、コンテンツを IntlayerNode でラップして返すため、ビジュアルエディタとの統合が可能です。一方、intlayer からインポートされる getIntlayer 関数は、追加のプロパティなしで直接コンテンツを返します。

    また、getTranslation 関数を使ってメタデータを宣言することもできます。ただし、メタデータの翻訳を自動化し、コンテンツを外部化するためには、コンテンツ宣言ファイルを使用することが推奨されます。

    src/app/[locale]/layout.tsx or src/app/[locale]/page.tsx
    import {  type IConfigLocales,  getTranslation,  getMultilingualUrls,} from "intlayer";import type { Metadata } from "next";import type { LocalParams } from "next-intlayer";export const generateMetadata = ({  params: { locale },}: LocalParams): Metadata => {  const t = <T>(content: IConfigLocales<T>) => getTranslation(content, locale);  return {    title: t<string>({      en: "My title",      fr: "Mon titre",      es: "Mi título",    }),    description: t({      en: "My description",      fr: "Ma description",      es: "Mi descripción",    }),  };};// ... 残りのコード

    メタデータの最適化について詳しくは、公式Next.jsドキュメントをご覧ください。

    （オプション）ステップ9：sitemap.xmlとrobots.txtの多言語対応

    sitemap.xmlとrobots.txtを多言語対応にするには、Intlayerが提供するgetMultilingualUrls関数を使用できます。この関数を使うことで、サイトマップ用の多言語URLを生成できます。

    src/app/sitemap.ts
    import { getMultilingualUrls } from "intlayer";import type { MetadataRoute } from "next";const sitemap = (): MetadataRoute.Sitemap => [  {    url: "https://example.com",    alternates: {      languages: getMultilingualUrls("https://example.com"),    },  },  {    url: "https://example.com/login",    alternates: {      languages: getMultilingualUrls("https://example.com/login"),    },  },  {    url: "https://example.com/register",    alternates: {      languages: getMultilingualUrls("https://example.com/register"),    },  },];export default sitemap;
    src/app/robots.ts
    import type { MetadataRoute } from "next";import { getMultilingualUrls } from "intlayer";// すべての多言語URLを取得する関数const getAllMultilingualUrls = (urls: string[]) =>  urls.flatMap((url) => Object.values(getMultilingualUrls(url)) as string[]);// robots.txtの設定を返す関数const robots = (): MetadataRoute.Robots => ({  rules: {    userAgent: "*", // すべてのユーザーエージェントに適用    allow: ["/"], // ルートパスは許可    disallow: getAllMultilingualUrls(["/login", "/register"]), // ログインと登録ページはクロール禁止  },  host: "https://example.com",  sitemap: `https://example.com/sitemap.xml`,});export default robots;

    サイトマップの最適化については、公式Next.jsドキュメントをご覧ください。robots.txtの最適化については、公式Next.jsドキュメントをご覧ください。

    （オプション）ステップ10：コンテンツの言語を変更する

    Next.jsでコンテンツの言語を変更するには、推奨される方法としてLinkコンポーネントを使用してユーザーを適切なローカライズされたページにリダイレクトする方法があります。Linkコンポーネントはページのプリフェッチを可能にし、完全なページリロードを回避するのに役立ちます。

    src/components/LocaleSwitcher.tsx
    "use client";import {  Locales,  getHTMLTextDir,  getLocaleName,  getLocalizedUrl,} from "intlayer";import { useLocale } from "next-intlayer";import { type FC } from "react";import Link from "next/link";const LocaleSwitcher: FC = () => {  const { locale, pathWithoutLocale, availableLocales } = useLocale();  const { setLocaleCookie } = useLocaleCookie();  return (    <div>      <button popoverTarget="localePopover">{getLocaleName(locale)}</button>      <div id="localePopover" popover="auto">        {availableLocales.map((localeItem) => (          <Link            href={getLocalizedUrl(pathWithoutLocale, localeItem)}            hrefLang={localeItem}            key={localeItem}            aria-current={locale === localeItem ? "page" : undefined}            onClick={() => setLocaleCookie(localeItem)}          >            <span>              {/* ロケール - 例: FR */}              {localeItem}            </span>            <span>              {/* 自身のロケールでの言語名 - 例: Français */}              {getLocaleName(localeItem, locale)}            </span>            <span dir={getHTMLTextDir(localeItem)} lang={localeItem}>              {/* 現在のロケールでの言語 - 例: Locales.SPANISHに設定されている場合のFrancés */}              {getLocaleName(localeItem)}            </span>            <span dir="ltr" lang={Locales.ENGLISH}>              {/* 英語での言語 - 例: French */}              {getLocaleName(localeItem, Locales.ENGLISH)}            </span>          </Link>        ))}      </div>    </div>  );};

    別の方法として、useLocaleフックが提供するsetLocale関数を使用することができます。この関数はページのプリフェッチを許可せず、ページをリロードします。

    この場合、router.push を使ったリダイレクトなしで、サーバーサイドのコードだけがコンテンツのロケールを変更します。

    src/components/LocaleSwitcher.tsx
    "use client";import { useRouter } from "next/navigation";import { useLocale } from "next-intlayer";import { getLocalizedUrl } from "intlayer";// ... 残りのコードconst router = useRouter();const { setLocale } = useLocale({  onLocaleChange: (locale) => {    router.push(getLocalizedUrl(pathWithoutLocale, locale));  },});return (  <button onClick={() => setLocale(Locales.FRENCH)}>フランス語に変更</button>);

    ドキュメント参照:

    （オプション）ステップ11：ローカライズされたリンクコンポーネントの作成

    アプリケーションのナビゲーションが現在のロケールを尊重するようにするために、カスタムの Link コンポーネントを作成できます。このコンポーネントは内部URLに自動的に現在の言語をプレフィックスとして付加します。例えば、フランス語を話すユーザーが「About」ページへのリンクをクリックすると、/about ではなく /fr/about にリダイレクトされます。

    この動作は以下の理由で有用です：

    • SEOとユーザー体験：ローカライズされたURLは、検索エンジンが言語ごとのページを正しくインデックスし、ユーザーに好みの言語でコンテンツを提供するのに役立ちます。
    • 一貫性: アプリケーション全体でローカライズされたリンクを使用することで、ナビゲーションが現在のロケール内に留まり、予期しない言語の切り替えを防ぎます。
    • 保守性: ローカライズのロジックを単一のコンポーネントに集約することで、URLの管理が簡素化され、アプリケーションの成長に伴いコードベースの保守や拡張が容易になります。

    以下は、TypeScriptで実装したローカライズされた Link コンポーネントの例です。

    src/components/Link.tsx
    "use client";import { getLocalizedUrl } from "intlayer";import NextLink, { type LinkProps as NextLinkProps } from "next/link";import { useLocale } from "next-intlayer";import { forwardRef, PropsWithChildren, type ForwardedRef } from "react";/** * 指定されたURLが外部リンクかどうかをチェックするユーティリティ関数。 * URLが http:// または https:// で始まる場合、外部リンクとみなされます。 */export const checkIsExternalLink = (href?: string): boolean =>  /^https?:\/\//.test(href ?? "");/** * 現在のロケールに基づいてhref属性を調整するカスタムLinkコンポーネント。 * 内部リンクの場合、`getLocalizedUrl`を使用してURLにロケールをプレフィックスとして付加します（例: /fr/about）。 * これにより、ナビゲーションが同じロケールのコンテキスト内に留まることを保証します。 */export const Link = forwardRef<  HTMLAnchorElement,  PropsWithChildren<NextLinkProps>>(({ href, children, ...props }, ref: ForwardedRef<HTMLAnchorElement>) => {  const { locale } = useLocale();  const isExternalLink = checkIsExternalLink(href.toString());  // リンクが内部リンクで有効な href が提供されている場合、ローカライズされた URL を取得します。  const hrefI18n: NextLinkProps["href"] =    href && !isExternalLink ? getLocalizedUrl(href.toString(), locale) : href;  return (    <NextLink href={hrefI18n} ref={ref} {...props}>      {children}    </NextLink>  );});Link.displayName = "Link";

    動作の仕組み

    • 外部リンクの検出:
      ヘルパー関数 checkIsExternalLink は、URLが外部リンクかどうかを判定します。外部リンクはローカライズの必要がないため、そのままにされます。

    • 現在のロケールの取得:
      useLocale フックは現在のロケール（例：フランス語の場合は fr）を提供します。

    • URLのローカライズ:
      内部リンク（つまり外部リンクでない場合）には、getLocalizedUrl が使用され、現在のロケールを自動的にURLの先頭に付加します。つまり、ユーザーがフランス語環境にいる場合、href に /about を渡すと、/fr/about に変換されます。

    • リンクの返却:
      コンポーネントはローカライズされたURLを持つ <a> 要素を返し、ナビゲーションがロケールに一貫して対応するようにします。

    この Link コンポーネントをアプリケーション全体に統合することで、一貫性のある言語対応のユーザー体験を維持しつつ、SEOや使いやすさの向上も実現できます。

    （オプション）ステップ12: バンドルサイズの最適化

    next-intlayer を使用すると、辞書はデフォルトですべてのページのバンドルに含まれます。バンドルサイズを最適化するために、Intlayer はマクロを使用して useIntlayer の呼び出しをインテリジェントに置き換えるオプションの SWC プラグインを提供しています。これにより、辞書は実際に使用されているページのバンドルにのみ含まれるようになります。

    この最適化を有効にするには、@intlayer/swc パッケージをインストールしてください。インストール後、next-intlayer は自動的にプラグインを検出して使用します。

    bash
    npm install @intlayer/swc --save-dev

    注意: この最適化は Next.js 13 以降でのみ利用可能です。

    注意: このパッケージは、Next.jsでSWCプラグインがまだ実験的なため、デフォルトではインストールされていません。将来的に変更される可能性があります。

    TypeScriptの設定

    Intlayerはモジュール拡張を使用して、TypeScriptの利点を活かし、コードベースをより強固にします。

    alt text

    alt text

    TypeScriptの設定に自動生成された型が含まれていることを確認してください。

    tsconfig.json
    {  // ... 既存のTypeScript設定  "include": [    // ... 既存のTypeScript設定    ".intlayer/**/*.ts", // 自動生成された型を含める  ],}

    Gitの設定

    Intlayerによって生成されたファイルは無視することを推奨します。これにより、これらのファイルをGitリポジトリにコミットするのを避けることができます。

    これを行うには、以下の指示を .gitignore ファイルに追加してください。

    .gitignore
    # Intlayerによって生成されたファイルを無視する.intlayer

    VS Code拡張機能

    Intlayerでの開発体験を向上させるために、公式のIntlayer VS Code拡張機能をインストールできます。

    VS Codeマーケットプレイスからインストール

    この拡張機能は以下を提供します：

    • 翻訳キーのオートコンプリート。
    • 欠落している翻訳のリアルタイムエラー検出。
    • 翻訳された内容のインラインプレビュー。
    • 翻訳を簡単に作成・更新できるクイックアクション。

    拡張機能の使用方法の詳細については、Intlayer VS Code Extension ドキュメントを参照してください。

    さらに進む

    さらに進むために、ビジュアルエディターを実装するか、CMSを使用してコンテンツを外部化することができます。

    ドキュメント履歴

    • 5.5.10 - 2025-06-29: 履歴の初期化
    IntlayerとNext.js
    Next.jsとページルーター
    Intlayerの今後のリリースに関する通知を受け取る