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

    Next.js 統合: next-intlayeruseLocale フックドキュメント

    このセクションでは、next-intlayer ライブラリ内の Next.js アプリケーション向けにカスタマイズされた useLocale フックの詳細なドキュメントを提供します。これはロケールの変更とルーティングを効率的に処理するよう設計されています。

    Next.js での useLocale のインポート

    Next.js アプリケーションで useLocale フックを利用するには、以下のようにインポートします。

    javascript
    import { useLocale } from "next-intlayer"; // Next.js でロケールとルーティングを管理するために使用

    使い方

    Next.js コンポーネント内で useLocale フックを実装する方法は以下の通りです。

    src/components/LocaleSwitcher.tsx
    "use client";import type { FC } from "react";import { Locales } from "intlayer";import { useLocale } from "next-intlayer";const LocaleSwitcher: FC = () => {  const { locale, defaultLocale, availableLocales, setLocale } = useLocale();  return (    <div>      <h1>現在のロケール: {locale}</h1>      <p>デフォルトロケール: {defaultLocale}</p>      <select value={locale} onChange={(e) => setLocale(e.target.value)}>        {availableLocales.map((loc) => (          <option key={loc} value={loc}>            {loc}          </option>        ))}      </select>    </div>  );};

    パラメーターと戻り値

    useLocale フックを呼び出すと、以下のプロパティを含むオブジェクトが返されます。

    • locale: React コンテキストで設定されている現在のロケール。
    • defaultLocale: 設定で定義された主要なロケール。
    • availableLocales: 設定で定義された利用可能なすべてのロケールのリスト。
    • setLocale: アプリケーションのロケールを変更し、それに応じてURLを更新する関数です。プレフィックスのルールを考慮し、設定に基づいてパスにロケールを追加するかどうかを管理します。next/navigationuseRouter を利用して、pushrefresh といったナビゲーション機能を実装しています。
    • pathWithoutLocale: ロケールを除いたパスを返す計算プロパティです。URLを比較する際に便利です。例えば、現在のロケールが fr で、URLが fr/my_path の場合、ロケールを除いたパスは /my_path となります。現在のパスを取得するために next/navigationusePathname を利用しています。

    結論

    next-intlayeruseLocale フックは、Next.js アプリケーションでロケールを管理するための重要なツールです。ロケールの保存、状態管理、URL の変更をシームレスに処理することで、複数のロケールに対応したアプリケーションを統合的に適応させるアプローチを提供します。

    ドキュメント履歴

    • 5.5.10 - 2025-06-29: 履歴初期化
    Intlayerの今後のリリースに関する通知を受け取る