ドキュメント: `intlayer` の `getLocalizedPath` 関数

Name: Intlayer
Author: Intlayer

説明

getLocalizedPath 関数は、canonical path（内部アプリケーションパス）を提供された locale とリライトルールに基づいてローカライズされたパスに解決します。言語ごとに異なる SEO に適した URL を生成する際に特に有用です。

主な機能:

[param] 構文を使用した動的ルートパラメータをサポートします。
プロジェクトの設定で定義したカスタムリライトルールに従ってパスを解決します。
指定したロケールに対するリライトルールが見つからない場合、自動的に canonical path にフォールバックします。

関数シグネチャ

getLocalizedPath(
  canonicalPath: string,         // 必須
  locale: Locales,               // 必須
  rewriteRules?: RoutingConfig['rewrite'] // オプション
): string

パラメータ

必須パラメータ

canonicalPath: string
- 説明: アプリケーション内部のパス（例: /about, /product/[id]）。
- 型: string
- 必須: はい
locale: Locales
- 説明: パスをローカライズする対象のロケール。
- 型: Locales
- 必須: はい

任意パラメータ

rewriteRules?: RoutingConfig['rewrite']
- 説明: カスタムのリライトルールを定義するオブジェクト。指定しない場合、プロジェクトの設定の routing.rewrite プロパティがデフォルトとして使用されます。
- 型: RoutingConfig['rewrite']
- デフォルト: configuration.routing.rewrite

戻り値

型: string
説明: 指定したロケール向けのローカライズされたパス。

使用例

基本的な使用例（設定あり）

intlayer.config.ts にカスタムのリライトを設定している場合:

import { getLocalizedPath, Locales } from "intlayer";

// 設定: { '/about': { en: '/about', fr: '/a-propos' } }
getLocalizedPath("/about", Locales.FRENCH);
// 出力: "/a-propos"

getLocalizedPath("/about", Locales.ENGLISH);
// 出力: "/about"

動的ルートでの使用

import { getLocalizedPath, Locales } from "intlayer";

// 設定: { '/product/[id]': { en: '/product/[id]', fr: '/produit/[id]' } }
getLocalizedPath("/product/123", Locales.FRENCH);
// 出力: "/produit/123"

手動リライトルール

手動のリライトルールを関数に渡すこともできます:

import { getLocalizedPath, Locales } from "intlayer";

const manualRules = {
  "/contact": {
    en: "/contact-us",
    fr: "/contactez-nous",
  },
};

getLocalizedPath("/contact", Locales.FRENCH, manualRules);
// Output: "/contactez-nous"

バージョン履歴

ドキュメント: intlayer の getLocalizedPath 関数

説明