Back to React Router

HydratedRouter

docs/api/framework-routers/HydratedRouter.md

7.6.21.8 KB
Original Source

HydratedRouter

<!-- ⚠️ ⚠️ IMPORTANT ⚠️ ⚠️ Thank you for helping improve our documentation! This file is auto-generated from the JSDoc comments in the source code, so please edit the JSDoc comments in the file below and this file will be re-generated once those changes are merged. https://github.com/remix-run/react-router/blob/main/packages/react-router/lib/dom-export/hydrated-router.tsx -->

[MODES: framework]

Summary

Framework-mode router component to be used to hydrate a router from a ServerRouter. See entry.client.tsx.

Signature

tsx
function HydratedRouter(props: HydratedRouterProps)

Props

getContext

Context factory function to be passed through to createBrowserRouter. This function will be called to create a fresh context instance on each navigation/fetch and made available to clientAction/clientLoader functions.

onError

An error handler function that will be called for any middleware, loader, action, or render errors that are encountered in your application. This is useful for logging or reporting errors instead of in the ErrorBoundary because it's not subject to re-rendering and will only run one time per error.

The errorInfo parameter is passed along from componentDidCatch and is only present for render errors.

tsx
<HydratedRouter onError=(error, info) => {
  let { location, params, unstable_pattern, errorInfo } = info;
  console.error(error, location, errorInfo);
  reportToErrorService(error, location, errorInfo);
}} />