カスタムフレームワーク

@react-router/dev を使用する代わりに、React Router のフレームワーク機能（ローダー、アクション、フェッチャーなど）を独自のバンドラーおよびサーバー抽象化に統合できます。

クライアントレンダリング

1. ルーターを作成する

ルートモジュール API（ローダー、アクションなど）を有効にするブラウザランタイム API は createBrowserRouter です。

これは、ローダー、アクション、エラー境界などをサポートするルートオブジェクトの配列を受け取ります。React Router Vite プラグインは routes.ts からこれを作成しますが、手動で（または抽象化を使用して）作成し、独自のバンドラーを使用できます。

import { createBrowserRouter } from "react-router";
 
let router = createBrowserRouter([
  {
    path: "/",
    Component: Root,
    children: [
      {
        path: "shows/:showId",
        Component: Show,
        loader: ({ request, params }) =>
          fetch(`/api/show/${params.id}.json`, {
            signal: request.signal,
          }),
      },
    ],
  },
]);

2. ルーターをレンダリングする

ブラウザでルーターをレンダリングするには、<RouterProvider> を使用します。

import {
  createBrowserRouter,
  RouterProvider,
} from "react-router";
import { createRoot } from "react-dom/client";
 
createRoot(document.getElementById("root")).render(
  <RouterProvider router={router} />
);

3. 遅延読み込み

ルートは、lazy プロパティを使用して、定義のほとんどを遅延的に取得できます。

createBrowserRouter([
  {
    path: "/show/:showId",
    lazy: async () => {
      let [loader, action, Component] = await Promise.all([
        import("./show.action.js"),
        import("./show.loader.js"),
        import("./show.component.js"),
      ]);
      return { loader, action, Component };
    },
  },
]);

サーバーレンダリング

カスタム設定をサーバーレンダリングするには、データ読み込みをレンダリングするために利用できるサーバー API がいくつかあります。

このガイドでは、その仕組みに関するいくつかのアイデアを紹介します。より深く理解するには、カスタムフレームワークのサンプルリポジトリを参照してください。

1. ルートを定義する

ルートは、クライアントと同じ種類のオブジェクトです。

export default [
  {
    path: "/",
    Component: Root,
    children: [
      {
        path: "shows/:showId",
        Component: Show,
        loader: ({ params }) => {
          return db.loadShow(params.id);
        },
      },
    ],
  },
];

2. 静的ハンドラーを作成する

createStaticHandler を使用して、ルートをリクエストハンドラーに変換します。

import { createStaticHandler } from "react-router";
import routes from "./some-routes";
 
let { query, dataRoutes } = createStaticHandler(routes);

3. ルーティングコンテキストを取得してレンダリングする

React Router は Web fetch リクエストで動作するため、サーバーがそうでない場合は、使用するオブジェクトを Web fetch Request オブジェクトに適応させる必要があります。

このステップでは、サーバーが Request オブジェクトを受け取ることを前提としています。

import { renderToString } from "react-dom/server";
import {
  createStaticHandler,
  createStaticRouter,
  StaticRouterProvider,
} from "react-router";
 
import routes from "./some-routes.js";
 
let { query, dataRoutes } = createStaticHandler(routes);
 
export async function handler(request: Request) {
  // 1. `query` を使用してアクション/ローダーを実行し、ルーティングコンテキストを取得します
  let context = await query(request);
 
  // `query` が Response を返す場合は、そのまま送信します（ルートはおそらくリダイレクトされました）
  if (context instanceof Response) {
    return context;
  }
 
  // 2. SSR 用の静的ルーターを作成します
  let router = createStaticRouter(dataRoutes, context);
 
  // 3. StaticRouterProvider ですべてをレンダリングします
  let html = renderToString(
    <StaticRouterProvider
      router={router}
      context={context}
    />
  );
 
  // 最も深い一致からアクションとローダーのヘッダーを設定します
  let leaf = context.matches[context.matches.length - 1];
  let actionHeaders = context.actionHeaders[leaf.route.id];
  let loaderHeaders = context.loaderHeaders[leaf.route.id];
  let headers = new Headers(actionHeaders);
  if (loaderHeaders) {
    for (let [key, value] of loaderHeaders.entries()) {
      headers.append(key, value);
    }
  }
 
  headers.set("Content-Type", "text/html; charset=utf-8");
 
  // 4. レスポンスを送信します
  return new Response(`<!DOCTYPE html>${html}`, {
    status: context.statusCode,
    headers,
  });
}

4. ブラウザでハイドレートする

ハイドレーションデータは window.__staticRouterHydrationData に埋め込まれます。これを使用してクライアント側のルーターを初期化し、<RouterProvider> をレンダリングします。

import { StrictMode } from "react";
import { hydrateRoot } from "react-dom/client";
import { RouterProvider } from "react-router/dom";
import routes from "./app/routes.js";
import { createBrowserRouter } from "react-router";
 
let router = createBrowserRouter(routes, {
  hydrationData: window.__staticRouterHydrationData,
});
 
hydrateRoot(
  document,
  <StrictMode>
    <RouterProvider router={router} />
  </StrictMode>
);