Actions represent the type of change to a location value.

This is a shortcut for creating application/json responses. Converts data to JSON and sets the Content-Type header.

A redirect response. Sets the status code and the Location header. Defaults to "302 Found".

Browser history stores the location in regular URLs. This is the standard for most web apps, but it requires some configuration on the server to ensure you serve the same app at multiple URLs.

Hash history stores the location in window.location.hash. This makes it ideal for situations where you don't want to send the location to the server for some reason, either because you do cannot configure it or the URL space is reserved for something else.

Memory history stores the current location in memory. It is designed for use in stateful non-browser environments like tests and React Native.

Creates a string URL path from the given pathname, search, and hash components.

Create a router and listen to history POP navigations

Returns a path with params interpolated.

Given an existing StaticHandlerContext and an error thrown at render time, provide an updated StaticHandlerContext suitable for a second SSR render

Check if the given error is an ErrorResponse generated from a 4xx/5xx Response thrown from an action/loader

Performs pattern matching on a URL pathname and returns information about the match.

Matches the given routes to a location and returns the match data.

Parses a string URL path into its separate pathname, search, and hash components.

Returns a resolved path object relative to the given pathname.

Route action function signature

Arguments passed to action functions

A RouteMatch contains info about how a route matched a URL.

A browser history stores the current location in regular URLs in a web browser environment. This is the standard for most web apps and provides the cleanest URLs the browser's address bar.

Function signature for determining the current scroll position

Function signature for determining the key to be used in scroll restoration for a given location

A hash history stores the current location in the fragment identifier portion of the URL in a web browser environment.

A history is an interface to the navigation stack. The history serves as the source of truth for the current location, as well as provides a set of methods that may be used to change it.

Route loader function signature

Arguments passed to loader functions

An entry in a history stack. A location contains information about the URL path, as well as possibly some arbitrary state and a key.

A memory history stores locations in memory. This is useful in stateful environments where there is no web browser, such as node tests or React Native.

The pathname, search, and hash values of a URL.

A PathMatch contains info about how a PathPattern matched on a URL pathname.

A PathPattern is used to match on some portion of a URL pathname.

A Router instance manages all navigation and data loading/mutations

Initialization options for createRouter

State maintained internally by the router. During a navigation, all states reflect the the "old" location unless otherwise noted.

Subscriber function signature for changes to router state

Route shouldRevalidate function signature. This runs after any submission (navigation or fetcher), so we flatten the navigation/fetcher submission onto the arguments. It shouldn't matter whether it came from a navigation or a fetcher, what really matters is the URLs and the formData since loaders have to re-run based on the data models that were potentially mutated.

A StaticHandler instance manages a singular SSR navigation/fetch event

State returned from a server-side query() call

A data route object, which is just a RouteObject with a required unique ID

Index routes must not have children

Non-index routes may have children, but cannot have index

A route object represents a logical route, with (optionally) its child routes organized in a tree-like structure.

Data that can be passed into hydrate a Router from SSR

A user-supplied object that describes a location. Used when providing entries to createMemoryHistory via its initialEntries option.

Potential states for state.navigation

The parameters that were parsed from the URL path.

Options to pass to fetch()

Options to pass to navigate() for either a Link or Form navigation

Describes a location that is the destination of some navigation, either via history.push or history.replace. May be either a URL or the pieces of a URL path.