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".

Returns a path with params interpolated.

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.

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.

Successful defer() result from a loader or action

Function provided by the framework-aware layers to set hasErrorBoundary from the framework-aware errorElement prop

Unsuccessful result from a loader or action

lazy() function to load a route definition, which can add non-matching related properties to a route

Route loader function signature

Arguments passed to loader functions

Function provided by the framework-aware layers to set any framework-specific properties from framework-agnostic properties

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.

Redirect result from a loader or action

Map of routeId -> data returned from a loader/action/error

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.

Successful result from a loader or action

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.

Result from a loader or action - potentially successful or unsuccessful

Active navigation/fetcher form methods are exposed in lowercase on the RouterState

Users can specify either lowercase or uppercase form methods on , useSubmit(), <fetcher.Form>, etc.

Keys we cannot change from within a lazy() function. We spread all other keys onto the route. Either they're meaningful to the router, or they'll get ignored.

The parameters that were parsed from the URL path.

In v7, active navigation/fetcher form methods are exposed in uppercase on the RouterState. This is to align with the normalization done via fetch().