Merge branch 'main' into release-next

Author: brophdawg11

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -11,7 +11,7 @@ body:
         - **All** bugs must have a **minimal** reproduction
           - Minimal means that it is not just pointing to a deployed site or a branch in your existing application
           - The preferred method is StackBlitz via [https://reactrouter.com/new](https://reactrouter.com/new)
-          - If Stackblitz is not an option, a Github repo based on a fresh `create-react-router` app is acceptable
+          - If Stackblitz is not an option, a GitHub repo based on a fresh `create-react-router` app is acceptable
           - Only in extraordinary circumstances will code snippets or maximal reproductions be accepted
         - Issue Review
           - Issues not meeting the above criteria will be closed and pointed to this document

.github/workflows/release.yml

@@ -51,7 +51,9 @@ jobs:
         # publish to npm.
       - name: 🚀 PR / Publish
         id: changesets
-        uses: changesets/[email protected]
+        # PLEASE KEEP THIS PINNED TO 1.4.10 to avoid a regression in 1.5.*
+        # See https://github.com/changesets/action/issues/465
+        uses: changesets/[email protected]
         with:
           version: pnpm run changeset:version
           commit: "chore: Update version for release"

GOVERNANCE.md

@@ -131,6 +131,7 @@
 - haivuw
 - hampelm
 - harshmangalam
+- HenriqueLimas
 - hernanif1
 - HK-SHAO
 - holynewbie
@@ -189,6 +190,7 @@
 - ken0x0a
 - kentcdodds
 - kettanaito
+- kilavvy
 - kiliman
 - kkirsche
 - kno-raziel
@@ -399,6 +401,7 @@
 - yracnet
 - ytori
 - yuleicul
+- zeevick10
 - zeromask1337
 - zheng-chuang
 - zxTomw

contributors.yml

@@ -141,7 +141,7 @@ We considered how to handle `shouldRevalidate` behavior. There's sort of 2 basic
 
 I _think_ (1) is preferred to keep the API at a minimum and avoid leaking into _other_ ways to opt-out of revalidation. We already have an API for that so let's lean into it.
 
-Additionally, another big con of (2) is that if we want to let them make revalidation decisions inside `dataStrategy` - we need to expose all of the informaiton required for that (`currentUrl`, `currentParams`, `nextUrl`, `nextParams`, `submission` info, `actionResult`, etc.) - the API becomes a mess.
+Additionally, another big con of (2) is that if we want to let them make revalidation decisions inside `dataStrategy` - we need to expose all of the information required for that (`currentUrl`, `currentParams`, `nextUrl`, `nextParams`, `submission` info, `actionResult`, etc.) - the API becomes a mess.
 
 Therefore we are aiming to stick with one and let `shouldRevalidate` be the only way to opt-out of revalidation.
 

decisions/0003-data-strategy.md

@@ -204,7 +204,7 @@ function NewErrorBoundary() {
   const error = useRouteError();
 
   if (error instanceof Response) {
-    return <MyOldCatchBoudnary error={error} />;
+    return <MyOldCatchBoundary error={error} />;
   } else {
     return <MyOldErrorBoundary error={error} />;
   }

decisions/0005-remixing-react-router.md

@@ -117,7 +117,7 @@ via [useRouteError](../hooks/useRouteError) hook.
 
 [modes: framework, data]
 
-Takes a promise returned from a [LoaderFunction](../Other/LoaderFunction) value to be resolved and rendered.
+Takes a promise returned from a [LoaderFunction](https://api.reactrouter.com/v7/types/react_router.LoaderFunction.html) value to be resolved and rendered.
 
 ```jsx
 import { useLoaderData, Await } from "react-router";

docs/api/components/Await.md

@@ -151,7 +151,7 @@ This state is inaccessible on the server as it is implemented on top of [`histor
 
 [modes: framework, data, declarative]
 
-Can be a string or a partial [Path](../Other/Path):
+Can be a string or a partial [Path](https://api.reactrouter.com/v7/interfaces/react_router.Path.html):
 
 ```tsx
 <Link to="/some/path" />

docs/api/components/Link.md

@@ -20,7 +20,7 @@ import { NavLink } from "react-router";
 <NavLink to="/message" />;
 ```
 
-States are available through the className, style, and children render props. See [NavLinkRenderProps](../Other/NavLinkRenderProps).
+States are available through the className, style, and children render props. See [NavLinkRenderProps](https://api.reactrouter.com/v7/types/react_router.NavLinkRenderProps).
 
 ```tsx
 <NavLink
@@ -233,7 +233,7 @@ Note that `pending` is only available with Framework and Data modes.
 
 [modes: framework, data, declarative]
 
-Can be a string or a partial [Path](../Other/Path):
+Can be a string or a partial [Path](https://api.reactrouter.com/v7/interfaces/react_router.Path):
 
 ```tsx
 <Link to="/some/path" />

docs/api/components/NavLink.md

@@ -15,7 +15,7 @@ Allow the application to block navigations within the SPA and present the user a
 ## Signature
 
 ```tsx
-useBlocker(shouldBlock): Blocker
+useBlocker(shouldBlock: boolean | BlockerFunction): Blocker
 ```
 
 ## Params
@@ -24,7 +24,43 @@ useBlocker(shouldBlock): Blocker
 
 [modes: framework, data]
 
-_No documentation_
+**boolean**
+
+Whether or not the navigation should be blocked. If `true`, the blocker will prevent the navigation. If `false`, the blocker will not prevent the navigation.
+
+[**BlockerFunction**](https://api.reactrouter.com/v7/types/react_router.BlockerFunction.html)
+
+A function that returns a boolean indicating whether the navigation should be blocked.
+
+```tsx
+const blocker = useBlocker(
+  ({ currentLocation, nextLocation, historyAction }) =>
+    value !== "" &&
+    currentLocation.pathname !== nextLocation.pathname
+);
+```
+
+## Blocker
+
+The [Blocker](https://api.reactrouter.com/v7/types/react_router.Blocker.html) object returned by the hook. It has the following properties:
+
+### `state`
+
+- `unblocked` - the blocker is idle and has not prevented any navigation
+- `blocked` - the blocker has prevented a navigation
+- `proceeding` - the blocker is proceeding through from a blocked navigation
+
+### `location`
+
+When in a `blocked` state, this represents the [`Location`](https://api.reactrouter.com/v7/interfaces/react_router.Location.html) to which we blocked a navigation. When in a `proceeding` state, this is the location being navigated to after a `blocker.proceed()` call.
+
+### `proceed()`
+
+When in a `blocked` state, you may call `blocker.proceed()` to proceed to the blocked location.
+
+### `reset()`
+
+When in a `blocked` state, you may call `blocker.reset()` to return the blocker back to an `unblocked` state and leave the user at the current location.
 
 ## Examples
 

docs/api/hooks/useBlocker.md

@@ -10,7 +10,7 @@ title: useLoaderData
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.useLoaderData.html)
 
-Returns the data from the closest route [LoaderFunction](../Other/LoaderFunction) or [ClientLoaderFunction](../Other/ClientLoaderFunction).
+Returns the data from the closest route [LoaderFunction](https://api.reactrouter.com/v7/types/react_router.LoaderFunction.html) or [ClientLoaderFunction](https://api.reactrouter.com/v7/types/react_router.ClientLoaderFunction.html).
 
 ```tsx
 import { useLoaderData } from "react-router";

docs/api/hooks/useLoaderData.md

@@ -27,7 +27,7 @@ function SomeComponent() {
 }
 ```
 
-It's often better to use [redirect](../utils/redirect) in [ActionFunction](../Other/ActionFunction) and [LoaderFunction](../Other/LoaderFunction) than this hook.
+It's often better to use [redirect](../utils/redirect) in [ActionFunction](https://api.reactrouter.com/v7/interfaces/react_router.ActionFunction.html) and [LoaderFunction](https://api.reactrouter.com/v7/types/react_router.LoaderFunction.html) than this hook.
 
 ## Signature
 

docs/api/hooks/useNavigate.md

@@ -10,7 +10,7 @@ title: useResolvedPath
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.useResolvedPath.html)
 
-Resolves the pathname of the given `to` value against the current location. Similar to [useHref](../hooks/useHref), but returns a [Path](../Other/Path) instead of a string.
+Resolves the pathname of the given `to` value against the current location. Similar to [useHref](../hooks/useHref), but returns a [Path](https://api.reactrouter.com/v7/interfaces/react_router.Path) instead of a string.
 
 ```tsx
 import { useResolvedPath } from "react-router";

docs/api/hooks/useResolvedPath.md

@@ -10,7 +10,7 @@ title: useRouteError
 
 [Reference Documentation ↗](https://api.reactrouter.com/v7/functions/react_router.useRouteError.html)
 
-Accesses the error thrown during an [ActionFunction](../Other/ActionFunction), [LoaderFunction](../Other/LoaderFunction), or component render to be used in a route module Error Boundary.
+Accesses the error thrown during an [ActionFunction](https://api.reactrouter.com/v7/interfaces/react_router.ActionFunction.html), [LoaderFunction](https://api.reactrouter.com/v7/types/react_router.LoaderFunction.html), or component render to be used in a route module Error Boundary.
 
 ```tsx
 export function ErrorBoundary() {

docs/api/hooks/useRouteError.md

@@ -0,0 +1,134 @@
+---
+title: Network Concurrency Management
+---
+
+# Network Concurrency Management
+
+[MODES: framework, data]
+
+## Overview
+
+When building web applications, managing network requests can be a daunting task. The challenges of ensuring up-to-date data and handling simultaneous requests often lead to complex logic in the application to deal with interruptions and race conditions. React Router simplifies this process by automating network management while mirroring and expanding upon the intuitive behavior of web browsers.
+
+To help understand how React Router handles concurrency, it's important to remember that after `form` submissions, React Router will fetch fresh data from the `loader`s. This is called revalidation.
+
+## Natural Alignment with Browser Behavior
+
+React Router's handling of network concurrency is heavily inspired by the default behavior of web browsers when processing documents.
+
+### Link Navigation
+
+**Browser Behavior**: When you click on a link in a browser and then click on another before the page transition completes, the browser prioritizes the most recent `action`. It cancels the initial request, focusing solely on the latest link clicked.
+
+**React Router Behavior**: React Router manages client-side navigation the same way. When a link is clicked within a React Router application, it initiates fetch requests for each `loader` tied to the target URL. If another navigation interrupts the initial navigation, React Router cancels the previous fetch requests, ensuring that only the latest requests proceed.
+
+### Form Submission
+
+**Browser Behavior**: If you initiate a form submission in a browser and then quickly submit another form again, the browser disregards the first submission, processing only the latest one.
+
+**React Router Behavior**: React Router mimics this behavior when working with forms. If a form is submitted and another submission occurs before the first completes, React Router cancels the original fetch requests. It then waits for the latest submission to complete before triggering page revalidation again.
+
+## Concurrent Submissions and Revalidation
+
+While standard browsers are limited to one request at a time for navigations and form submissions, React Router elevates this behavior. Unlike navigation, with [`useFetcher`][use_fetcher] multiple requests can be in flight simultaneously.
+
+React Router is designed to handle multiple form submissions to server `action`s and concurrent revalidation requests efficiently. It ensures that as soon as new data is available, the state is updated promptly. However, React Router also safeguards against potential pitfalls by refraining from committing stale data when other `action`s introduce race conditions.
+
+For instance, if three form submissions are in progress, and one completes, React Router updates the UI with that data immediately without waiting for the other two so that the UI remains responsive and dynamic. As the remaining submissions finalize, React Router continues to update the UI, ensuring that the most recent data is displayed.
+
+Using this key:
+
+- `|`: Submission begins
+- ✓: Action complete, data revalidation begins
+- ✅: Revalidated data is committed to the UI
+- ❌: Request cancelled
+
+We can visualize this scenario in the following diagram:
+
+```text
+submission 1: |----✓-----✅
+submission 2:    |-----✓-----✅
+submission 3:             |-----✓-----✅
+```
+
+However, if a subsequent submission's revalidation completes before an earlier one, React Router discards the earlier data, ensuring that only the most up-to-date information is reflected in the UI:
+
+```text
+submission 1: |----✓---------❌
+submission 2:    |-----✓-----✅
+submission 3:             |-----✓-----✅
+```
+
+Because the revalidation from submission (2) started later and landed earlier than submission (1), the requests from submission (1) are canceled and only the data from submission (2) is committed to the UI. It was requested later, so it's more likely to contain the updated values from both (1) and (2).
+
+## Potential for Stale Data
+
+It's unlikely your users will ever experience this, but there are still chances for the user to see stale data in very rare conditions with inconsistent infrastructure. Even though React Router cancels requests for stale data, they will still end up making it to the server. Canceling a request in the browser simply releases browser resources for that request; it can't "catch up" and stop it from getting to the server. In extremely rare conditions, a canceled request may change data after the interrupting `action`'s revalidation lands. Consider this diagram:
+
+```text
+     👇 interruption with new submission
+|----❌----------------------✓
+       |-------✓-----✅
+                             👆
+                  initial request reaches the server
+                  after the interrupting submission
+                  has completed revalidation
+```
+
+The user is now looking at different data than what is on the server. Note that this problem is both extremely rare and exists with default browser behavior, too. The chance of the initial request reaching the server later than both the submission and revalidation of the second is unexpected on any network and server infrastructure. If this is a concern with your infrastructure, you can send timestamps with your form submissions and write server logic to ignore stale submissions.
+
+## Example
+
+In UI components like comboboxes, each keystroke can trigger a network request. Managing such rapid, consecutive requests can be tricky, especially when ensuring that the displayed results match the most recent query. However, with React Router, this challenge is automatically handled, ensuring that users see the correct results without developers having to micromanage the network.
+
+```tsx filename=app/pages/city-search.tsx
+export async function loader({ request }) {
+  const { searchParams } = new URL(request.url);
+  const cities = await searchCities(searchParams.get("q"));
+  return cities;
+}
+
+export function CitySearchCombobox() {
+  const fetcher = useFetcher<typeof loader>();
+
+  return (
+    <fetcher.Form action="/city-search">
+      <Combobox aria-label="Cities">
+        <ComboboxInput
+          name="q"
+          onChange={(event) =>
+            // submit the form onChange to get the list of cities
+            fetcher.submit(event.target.form)
+          }
+        />
+
+        {/* render with the loader's data */}
+        {fetcher.data ? (
+          <ComboboxPopover className="shadow-popup">
+            {fetcher.data.length > 0 ? (
+              <ComboboxList>
+                {fetcher.data.map((city) => (
+                  <ComboboxOption
+                    key={city.id}
+                    value={city.name}
+                  />
+                ))}
+              </ComboboxList>
+            ) : (
+              <span>No results found</span>
+            )}
+          </ComboboxPopover>
+        ) : null}
+      </Combobox>
+    </fetcher.Form>
+  );
+}
+```
+
+All the application needs to know is how to query the data and how to render it. React Router handles the network.
+
+## Conclusion
+
+React Router offers developers an intuitive, browser-based approach to managing network requests. By mirroring browser behaviors and enhancing them where needed, it simplifies the complexities of concurrency, revalidation, and potential race conditions. Whether you're building a simple webpage or a sophisticated web application, React Router ensures that your user interactions are smooth, reliable, and always up to date.
+
+[use_fetcher]: ../api/hooks/useFetcher

docs/explanation/concurrency.md

@@ -0,0 +1,34 @@
+---
+title: Accessibility
+---
+
+# Accessibility
+
+Accessibility in a React Router app looks a lot like accessibility on the web in general. Using proper semantic markup and following the [Web Content Accessibility Guidelines (WCAG)][wcag] will get you most of the way there.
+
+React Router makes certain accessibility practices the default where possible and provides APIs to help where it's not.
+
+## Links
+
+The [`<Link>` component][link] renders a standard anchor tag, meaning that you get its accessibility behaviors from the browser for free!
+
+React Router also provides the [`<NavLink/>`][navlink] which behaves the same as `<Link>`, but it also provides context for assistive technology when the link points to the current page. This is useful for building navigation menus or breadcrumbs.
+
+## Routing
+
+If you are rendering [`<Scripts>`][scripts] in your app, there are some important things to consider to make client-side routing more accessible for your users.
+
+With a traditional multi-page website we don't have to think about route changes too much. Your app renders an anchor tag, and the browser handles the rest. If your users disable JavaScript, your React Router app should already work this way by default!
+
+When the client scripts in React Router are loaded, React Router takes control of routing and prevents the browser's default behavior. React Router doesn't make any assumptions about your UI as the route changes. There are some important features you'll want to consider as a result, including:
+
+- **Focus management:** What element receives focus when the route changes? This is important for keyboard users and can be helpful for screen-reader users.
+- **Live-region announcements:** Screen-reader users also benefit from announcements when a route has changed. You may want to also notify them during certain transition states depending on the nature of the change and how long loading is expected to take.
+
+In 2019, [Marcy Sutton led and published findings from user research][marcy-sutton-led-and-published-findings-from-user-research] to help developers build accessible client-side routing experiences.
+
+[link]: ../api/components/Link
+[navlink]: ../api/components/NavLink
+[scripts]: ../api/components/Scripts
+[wcag]: https://www.w3.org/WAI/standards-guidelines/wcag/
+[marcy-sutton-led-and-published-findings-from-user-research]: https://www.gatsbyjs.com/blog/2019-07-11-user-testing-accessible-client-routing