Back to React Router

HashRouter

docs/api/declarative-routers/HashRouter.md

7.6.21.8 KB
Original Source

HashRouter

<!-- ⚠️ ⚠️ 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/lib.tsx -->

[MODES: declarative]

Summary

Reference Documentation ↗

A declarative <Router> that stores the location in the hash portion of the URL so it is not sent to the server.

Signature

tsx
function HashRouter({
  basename,
  children,
  unstable_useTransitions,
  window,
}: HashRouterProps)

Props

basename

Application basename

children

<Route> components describing your route configuration

unstable_useTransitions

Control whether router state updates are internally wrapped in React.startTransition.

  • When left undefined, all router state updates are wrapped in React.startTransition
  • When set to true, Link and Form navigations will be wrapped in React.startTransition and all router state updates are wrapped in React.startTransition
  • When set to false, the router will not leverage React.startTransition on any navigations or state changes.

For more information, please see the docs.

window

Window object override. Defaults to the global window instance