main
分支
main (6.23.1)dev
版本
6.23.1v4/5.xv3.x
createStaticRouter

createStaticRouter

createStaticRouter 用在您想要為資料路由器提升層級以在伺服器上呈現時(也就是 Node 或其他 JavaScript 執行階段)。更多完整概觀,請參閱 伺服器端渲染 指南。

import {
  createStaticHandler,
  createStaticRouter,
  StaticRouterProvider,
} from "react-router-dom/server";
import Root, {
  loader as rootLoader,
  ErrorBoundary as RootBoundary,
} from "./root";

const routes = [
  {
    path: "/",
    loader: rootLoader,
    Component: Root,
    ErrorBoundary: RootBoundary,
  },
];

export async function renderHtml(req) {
  let { query, dataRoutes } = createStaticHandler(routes);
  let fetchRequest = createFetchRequest(req);
  let context = await query(fetchRequest);

  // If we got a redirect response, short circuit and let our Express server
  // handle that directly
  if (context instanceof Response) {
    throw context;
  }

  let router = createStaticRouter(dataRoutes, context);
  return ReactDOMServer.renderToString(
    <React.StrictMode>
      <StaticRouterProvider
        router={router}
        context={context}
      />
    </React.StrictMode>
  );
}

類型宣告

declare function createStaticRouter(
  routes: RouteObject[],
  context: StaticHandlerContext,
  opts: {
    future?: {
      v7_partialHydration?: boolean;
    };
  }
): Router;

opts.future

一組可供 未來旗標 用於啟用此靜態路由器的選用設定。建議及早選擇加入新發布的未來旗標,以利您最終順利移轉到 v7。

const router = createBrowserRouter(routes, {
  future: {
    // Opt-into partial hydration
    v7_partialHydration: true,
  },
});

目前有以下這些可用未來旗標

旗標 描述
v7_partialHydration 為伺服器端呈現的應用程式提供部分水合支援

另請參閱