Package-level declarations
Types
Form props available to fetchers
Submits a fetcher <form>
to the server without reloading the page.
Submit options available to fetchers
Form props available to navigations
Form props shared by navigations and fetchers
Submit options shared by both navigations and fetchers
Submits a HTML <form>
to the server without reloading the page.
Submit options available to navigations
Properties
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.
The public API for rendering a history-aware <a>
.
A <Link>
wrapper that knows if it's "active" or not.
Given a Remix Router instance, render the appropriate UI
This component will emulate the browser's scroll restoration on location changes.
Functions
Creates a URLSearchParams object using the given initializer.
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.
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>
.
Wrapper around useBlocker to show a window.confirm prompt to users instead of building a custom UI with useBlocker.
When rendered inside a RouterProvider, will restore scroll positions on navigations
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.
Return a boolean indicating if there is an active view transition to the given href. You can use this value to render CSS classes or viewTransitionName styles onto your elements