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