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

    Next.js 統合: useIntlayerAsync フック ドキュメント

    useIntlayerAsync フックは、プリレンダリングされた辞書を返すだけでなく、更新を非同期に取得する機能を useIntlayer から拡張しており、初回レンダリング後にローカライズされたコンテンツを頻繁に更新するアプリケーションに最適です。

    概要

    • 非同期辞書読み込み:
      クライアント側では、useIntlayerAsync はまずプリレンダリングされたロケール辞書を返し(useIntlayer と同様)、その後に非同期で新たに利用可能なリモート辞書を取得してマージします。
    • 進行状態管理:
      このフックは、リモート辞書が取得中であることを示す isLoading 状態も提供します。これにより、開発者は読み込みインジケーターやスケルトン状態を表示して、よりスムーズなユーザー体験を実現できます。

    環境設定

    Intlayerは、非開発者でもアプリケーションのコンテンツをシームレスに管理・更新できるヘッドレスコンテンツソース管理(CSM)システムを提供します。Intlayerの直感的なダッシュボードを使用することで、チームはコードを直接変更することなく、ローカライズされたテキスト、画像、その他のリソースを編集できます。これにより、コンテンツ管理プロセスが効率化され、コラボレーションが促進され、迅速かつ容易に更新が行えるようになります。

    Intlayerを始めるには、まずダッシュボードで登録し、アクセストークンを取得する必要があります。認証情報を取得したら、以下のように設定ファイルに追加してください。

    intlayer.config.ts
    import type { IntlayerConfig } from "intlayer";export default {  // ...  editor: {    clientId: process.env.INTLAYER_CLIENT_ID,    clientSecret: process.env.INTLAYER_CLIENT_SECRET,  },} satisfies IntlayerConfig;

    資格情報を設定した後、次のコマンドを実行して新しいロケール辞書をIntlayerにプッシュできます:

    bash
    npx intlayer dictionary push -d my-first-dictionary-key

    このコマンドは初期のコンテンツ辞書をアップロードし、Intlayerプラットフォームを通じて非同期に取得および編集できるようにします。

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

    useIntlayerAsyncクライアントサイドコンポーネント向けのため、useIntlayerと同じクライアントエントリポイントからインポートします:

    tsx
    "use client";import { useIntlayerAsync } from "next-intlayer";

    Next.jsのApp Routerでサーバーコンポーネントとクライアントコンポーネントが分かれている場合は、インポートするファイルの先頭に必ず "use client" の注釈を付けてください。

    パラメーター

    1. key:
      : DictionaryKeys
      ローカライズされたコンテンツブロックを識別するための辞書キーです。このキーはコンテンツ宣言ファイルで定義されている必要があります。

    2. locale(省略可能):
      : Locales
      対象とする特定のロケールです。省略した場合、フックはクライアントコンテキストのロケールを使用します。

    3. isRenderEditor(省略可能、デフォルトは true):
      : boolean
      コンテンツがIntlayerエディターのオーバーレイでレンダリング可能な状態にするかどうかを決定します。falseに設定すると、返される辞書データにはエディター固有の機能が含まれません。

    戻り値

    このフックは、keylocaleでキー付けされたローカライズされたコンテンツを含む辞書オブジェクトを返します。また、遠隔辞書が現在取得中かどうかを示すisLoadingというブール値も含まれます。

    Next.jsでの使用例

    クライアントサイドコンポーネントの例

    src/components/AsyncClientComponentExample.tsx
    "use client";import { useEffect, type FC } from "react";import { useIntlayerAsync } from "next-intlayer";export const AsyncClientComponentExample: FC = () => {  const { title, description, isLoading } = useIntlayerAsync("async-component");  useEffect(() => {    if (isLoading) {      console.log("コンテンツを読み込み中...");    }  }, [isLoading]);  return (    <div>      <h1>{title.value}</h1>      <p>{description.value}</p>    </div>  );};

    重要なポイント:

    • 初回レンダリング時、titledescription は事前レンダリングされたロケール辞書から取得されます。
    • isLoadingtrue の間は、バックグラウンドでリモートリクエストが行われ、更新された辞書が取得されます。
    • フェッチが完了すると、titledescription は最新のコンテンツに更新され、isLoadingfalse に戻ります。

    属性のローカライズ処理

    useIntlayer と同様に、さまざまなHTML属性(例:alttitlearia-label)のローカライズされた値を取得できます:

    tsx
    <img src={title.image.src.value} alt={title.image.alt.value} />

    辞書ファイル

    すべてのコンテンツキーは、型の安全性を確保し実行時エラーを防ぐために、コンテンツ宣言ファイルで定義する必要があります。これらのファイルはTypeScriptの検証を可能にし、常に存在するキーとロケールを参照していることを保証します。

    コンテンツ宣言ファイルの設定手順はこちらでご覧いただけます。

    さらに詳しく

    • Intlayer ビジュアルエディター:
      Intlayer ビジュアルエディターと統合することで、UIから直接コンテンツの管理や編集が可能になります。詳細はこちらをご覧ください。

    まとめuseIntlayerAsync は、事前レンダリングされた辞書と非同期の辞書更新を組み合わせることで、ユーザー体験を向上させ、コンテンツの鮮度を維持するために設計された強力なクライアントサイドフックです。isLoading と TypeScript ベースのコンテンツ宣言を活用することで、Next.js アプリケーションに動的でローカライズされたコンテンツをシームレスに統合できます。

    ドキュメント履歴

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