v6.18.0

Compare Source

Minor Changes

• Add support for manual fetcher key specification via useFetcher({ key: string }) so you can access the same fetcher instance from different components in your application without prop-drilling (RFC) (#​10960)

  • Fetcher keys are now also exposed on the fetchers returned from useFetchers so that they can be looked up by key

• Add navigate/fetcherKey params/props to useSumbit/Form to support kicking off a fetcher submission under the hood with an optionally user-specified key (#​10960)

  • Invoking a fetcher in this way is ephemeral and stateless
  • If you need to access the state of one of these fetchers, you will need to leverage useFetcher({ key }) to look it up elsewhere

Patch Changes

• Adds a fetcher context to RouterProvider that holds completed fetcher data, in preparation for the upcoming future flag that will change the fetcher persistence/cleanup behavior (#​10961)
• Fix the future prop on BrowserRouter, HashRouter and MemoryRouter so that it accepts a Partial<FutureConfig> instead of requiring all flags to be included. (#​10962)
• Updated dependencies:
  • @remix-run/[email protected]
  • [email protected]

v6.17.0

Compare Source

Minor Changes

• Add experimental support for the View Transitions API via document.startViewTransition to enable CSS animated transitions on SPA navigations in your application. (#​10916)

  The simplest approach to enabling a View Transition in your React Router app is via the new <Link unstable_viewTransition> prop. This will cause the navigation DOM update to be wrapped in document.startViewTransition which will enable transitions for the DOM update. Without any additional CSS styles, you'll get a basic cross-fade animation for your page.

  If you need to apply more fine-grained styles for your animations, you can leverage the unstable_useViewTransitionState hook which will tell you when a transition is in progress and you can use that to apply classes or styles:

  function ImageLink(to, src, alt) {
    let isTransitioning = unstable_useViewTransitionState(to);
    return (
      <Link to={to} unstable_viewTransition>
        <img
          src={src}
          alt={alt}
          style={{
            viewTransitionName: isTransitioning ? "image-expand" : "",
          }}
        />
      </Link>
    );
  }

  You can also use the <NavLink unstable_viewTransition> shorthand which will manage the hook usage for you and automatically add a transitioning class to the <a> during the transition:

  a.transitioning img {
    view-transition-name: "image-expand";
  }

  <NavLink to={to} unstable_viewTransition>
    <img src={src} alt={alt} />
  </NavLink>

  For an example usage of View Transitions with React Router, check out our fork of the Astro Records demo.

  For more information on using the View Transitions API, please refer to the Smooth and simple transitions with the View Transitions API guide from the Google Chrome team.

  Please note, that because the ViewTransition API is a DOM API, we now export a specific RouterProvider from react-router-dom with this functionality. If you are importing RouterProvider from react-router, then it will not support view transitions. (#​10928

Patch Changes

• Log a warning and fail gracefully in ScrollRestoration when sessionStorage is unavailable (#​10848)
• Updated dependencies:
  • @remix-run/[email protected]
  • [email protected]

v6.16.0

Compare Source

Minor Changes

• Updated dependencies:
  • @remix-run/[email protected]
  • [email protected]

Patch Changes

• Properly encode rendered URIs in server rendering to avoid hydration errors (#​10769)

v6.15.0

Compare Source

Minor Changes

• Add's a new redirectDocument() function which allows users to specify that a redirect from a loader/action should trigger a document reload (via window.location) instead of attempting to navigate to the redirected location via React Router (#​10705)

Patch Changes

• Fixes an edge-case affecting web extensions in Firefox that use URLSearchParams and the useSearchParams hook. (#​10620)
• Do not include hash in useFormAction() for unspecified actions since it cannot be determined on the server and causes hydration issues (#​10758)
• Reorder effects in unstable_usePrompt to avoid throwing an exception if the prompt is unblocked and a navigation is performed synchronously (#​10687, #​10718)
• Updated dependencies:
  • @remix-run/[email protected]
  • [email protected]

v6.14.2

Compare Source

Patch Changes

• Properly decode element id when emulating hash scrolling via <ScrollRestoration> (#​10682)
• Add missing <Form state> prop to populate history.state on submission navigations (#​10630)
• Support proper hydration of Error subclasses such as ReferenceError/TypeError (#​10633)
• Updated dependencies:
  • @remix-run/[email protected]
  • [email protected]

v6.14.1

Compare Source

Patch Changes

• Updated dependencies:
  • [email protected]
  • @remix-run/[email protected]

v6.14.0

Compare Source

Minor Changes

• Add support for application/json and text/plain encodings for useSubmit/fetcher.submit. To reflect these additional types, useNavigation/useFetcher now also contain navigation.json/navigation.text and fetcher.json/fetcher.text which include the json/text submission if applicable (#​10413)

  // The default behavior will still serialize as FormData
  function Component() {
    let navigation = useNavigation();
    let submit = useSubmit();
    submit({ key: "value" }, { method: "post" });
    // navigation.formEncType => "application/x-www-form-urlencoded"
    // navigation.formData    => FormData instance
  }
  
  async function action({ request }) {
    // request.headers.get("Content-Type") => "application/x-www-form-urlencoded"
    // await request.formData()            => FormData instance
  }

  // Opt-into JSON encoding with `encType: "application/json"`
  function Component() {
    let navigation = useNavigation();
    let submit = useSubmit();
    submit({ key: "value" }, { method: "post", encType: "application/json" });
    // navigation.formEncType => "application/json"
    // navigation.json        => { key: "value" }
  }
  
  async function action({ request }) {
    // request.headers.get("Content-Type") => "application/json"
    // await request.json()                => { key: "value" }
  }

  // Opt-into text encoding with `encType: "text/plain"`
  function Component() {
    let navigation = useNavigation();
    let submit = useSubmit();
    submit("Text submission", { method: "post", encType: "text/plain" });
    // navigation.formEncType => "text/plain"
    // navigation.text        => "Text submission"
  }
  
  async function action({ request }) {
    // request.headers.get("Content-Type") => "text/plain"
    // await request.text()                => "Text submission"
  }

Patch Changes

• When submitting a form from a submitter element, prefer the built-in new FormData(form, submitter) instead of the previous manual approach in modern browsers (those that support the new submitter parameter) (#​9865, #​10627)
  • For browsers that don't support it, we continue to just append the submit button's entry to the end, and we also add rudimentary support for type="image" buttons
  • If developers want full spec-compliant support for legacy browsers, they can use the formdata-submitter-polyfill
• Call window.history.pushState/replaceState before updating React Router state (instead of after) so that window.location matches useLocation during synchronous React 17 rendering (#​10448)
  • ⚠️ However, generally apps should not be relying on window.location and should always reference useLocation when possible, as window.location will not be in sync 100% of the time (due to popstate events, concurrent mode, etc.)
• Fix tsc --skipLibCheck:false issues on React 17 (#​10622)
• Upgrade typescript to 5.1 (#​10581)
• Updated dependencies:
  • [email protected]
  • @remix-run/[email protected]

v6.13.0

Compare Source

Minor Changes

• Move React.startTransition usage behind a future flag to avoid issues with existing incompatible Suspense usages. We recommend folks adopting this flag to be better compatible with React concurrent mode, but if you run into issues you can continue without the use of startTransition until v7. Issues usually boils down to creating net-new promises during the render cycle, so if you run into issues you should either lift your promise creation out of the render cycle or put it behind a useMemo. (#​10596)

  Existing behavior will no longer include React.startTransition:

  <BrowserRouter>
    <Routes>{/*...*/}</Routes>
  </BrowserRouter>
  
  <RouterProvider router={router} />

  If you wish to enable React.startTransition, pass the future flag to your component:

  <BrowserRouter future={{ v7_startTransition: true }}>
    <Routes>{/*...*/}</Routes>
  </BrowserRouter>
  
  <RouterProvider router={router} future={{ v7_startTransition: true }}/>

Patch Changes

• Work around webpack/terser React.startTransition minification bug in production mode (#​10588)
• Updated dependencies:
  • [email protected]

v6.12.1

Compare Source

Warning
Please use version 6.13.0 or later instead of 6.12.1. This version suffers from a webpack/terser minification issue resulting in invalid minified code in your resulting production bundles which can cause issues in your application. See #​10579 for more details.

Patch Changes

• Adjust feature detection of React.startTransition to fix webpack + react 17 compilation error (#​10569)
• Updated dependencies:
  • [email protected]

v6.12.0

Compare Source

Minor Changes

• Wrap internal router state updates with React.startTransition if it exists (#​10438)

Patch Changes

• Re-throw DOMException (DataCloneError) when attempting to perform a PUSH navigation with non-serializable state. (#​10427)
• Updated dependencies:
  • @remix-run/[email protected]
  • [email protected]

v6.11.2

Compare Source

Patch Changes

• Export SetURLSearchParams type (#​10444)
• Updated dependencies:
  • [email protected]
  • @remix-run/[email protected]