Actions represent the type of change to a location value.

A @remix-run/router-aware <form>. It behaves like a normal form except that the interaction with the server is with fetch instead of new document requests, allowing components to add nicer UX to the page as the form is submitted and returns with data.

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

The public API for rendering a history-aware .

A wrapper that knows if it's "active" or not.

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

Component to use for rendering lazily loaded data from returning defer() in a loader function

A <Router> for use in web browsers. Provides the cleanest URLs.

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

Creates a route config from a React "children" object, which is usually either a <Route> element or an array of them. Used internally by <Routes> to create a route config from its children.

Creates a route config from a React "children" object, which is usually either a <Route> element or an array of them. Used internally by <Routes> to create a route config from its children.

Creates a URLSearchParams object using the given initializer.

Returns a path with params interpolated.

A <Router> for use in web browsers. Stores the location in the hash portion of the URL so it is not sent to the server.

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.

A that stores all entries in memory.

Changes the current location.

Renders the child route's element, if there is one.

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

Renders the result of matchRoutes() into a React element.

Returns a resolved path object relative to the given pathname.

Declares an element that should be rendered at a certain URL path.

Provides location context for the rest of the app.

Given a Remix Router instance, render the appropriate UI

A container for a nested tree of elements that renders the branch that best matches the current location.

This component will emulate the browser's scroll restoration on location changes.

Returns the ID for the nearest contextual route

When rendered inside a RouterProvider, will restore scroll positions on navigations

Allow the application to block navigations within the SPA and present the user a confirmation dialog to confirm the navigation. Mostly used to avoid using half-filled form data. This does not handle hard-reloads or cross-origin navigations.

Wrapper around useBlocker to show a window.confirm prompt to users instead of building a custom UI with useBlocker.

Returns the action data for the nearest ancestor Route action

Returns the error from the nearest ancestor value

Returns the happy-path data from the nearest ancestor value

Setup a callback to be fired on the window's beforeunload event. This is useful for saving some data to window.localStorage just before the page refreshes.

Interacts with route loaders and actions without causing a navigation. Great for any interaction that stays on the same page.

Provides all fetchers currently on the page. Useful for layouts and parent routes that need to provide pending/optimistic UI regarding the fetch.

Returns the full href for the given "to" value. This is useful for building custom links that are also accessible and preserve right-click behavior.

Returns true if this component is a descendant of a .

Handles the click behavior for router <Link> components. This is useful if you need to create custom <Link> components with the same click behavior we use in our exported <Link>.

Returns the loader data for the nearest ancestor Route loader

Returns the current location object, which represents the current URL in web browsers.

Returns a PathMatch object if the given pattern matches the current URL. This is useful for components that need to know "active" state, e.g. .

Returns the active route matches, useful for accessing loaderData for parent/child routes or the route "handle" property

Returns an imperative method for changing the location. Used by s, but may also be used by other elements to change the location.

Returns the current navigation, defaulting to an "idle" navigation when no navigation is in progress

Returns the current navigation action which describes how the router came to the current location, either by a pop, push, or replace on the history stack.

Returns the element for the child route at this level of the route hierarchy. Used internally by to render child routes.

Returns the context (if provided) for the child route at this level of the route hierarchy.

Returns an object of key/value pairs of the dynamic params from the current URL that were matched by the route path.

Resolves the pathname of the given to value against the current location.

Returns a revalidate function for manually triggering revalidation, as well as the current state of any manual revalidations

Returns the nearest ancestor Route error, which could be a loader/action error or a render error. This is intended to be called from your ErrorBoundary/errorElement to display a proper error message.

Returns the loaderData for the given routeId

Returns the element of the route that matched the current location, prepared with the correct context to render the remainder of the route tree. Route elements in the tree must render an to render their child route's element.

A convenient wrapper for reading and writing search parameters via the URLSearchParams interface.

Returns a function that may be used to programmatically submit a form (or some arbitrary data) to the server.

Route action function signature

Arguments passed to action functions

Submits a fetcher <form> to the server without reloading the page.

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

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

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

The interface for the navigate() function returned from useNavigate().

A Navigator is a "location changer"; it's how you get to different locations.

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.

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.

Submits a HTML <form> to the server without reloading the page.

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

The parameters that were parsed from the URL path.

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.

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