Merge branch 'main' into release-next

Author: brophdawg11

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -23,7 +23,7 @@ body:
 
         ### Test Case Starters:
 
-        * [Using `<RouterProvider>`](https://stackblitz.com/github/remix-run/react-router/tree/main/examples/data-router?file=src/App.tsx)
+        * [Using `<RouterProvider>`](https://stackblitz.com/github/remix-run/react-router/tree/main/examples/basic-data-router?file=src/app.tsx)
         * [Using `<BrowserRouter>`](https://stackblitz.com/github/remix-run/react-router/tree/main/examples/basic?file=src/App.tsx)
   - type: input
     attributes:

.github/workflows/no-response.yml

@@ -15,20 +15,27 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 🥺 Handle Ghosting
-        uses: actions/stale@v7
+        uses: actions/stale@v8
         with:
-          days-before-close: 10
           close-issue-message: >
-            This issue has been automatically closed because we haven't received a
-            response from the original author 🙈. This automation helps keep the issue
-            tracker clean from issues that aren't actionable. Please reach out if you
-            have more information for us! 🙂
+            This issue has been automatically closed because we didn't hear
+            anything from the original author after the previous notice.
           close-pr-message: >
-            This PR has been automatically closed because we haven't received a
-            response from the original author 🙈. This automation helps keep the issue
-            tracker clean from PRs that aren't actionable. Please reach out if you
-            have more information for us! 🙂
-          # don't automatically mark issues/PRs as stale
-          days-before-stale: -1
+            This PR has been automatically closed because we didn't hear
+            anything from the original author after the previous notice.
           stale-issue-label: needs-response
+          stale-issue-message: >
+            This issue has been automatically marked stale because we haven't
+            received a response from the original author in a while 🙈. This
+            automation helps keep the issue tracker clean from issues that are
+            not actionable. Please reach out if you have more information for us
+            or you think this issue shouldn't be closed! 🙂 If you don't do so
+            within 7 days, this issue will be automatically closed.
           stale-pr-label: needs-response
+          stale-pr-message: >
+            This PR has been automatically marked stale because we haven't
+            received a response from the original author in a while 🙈. This
+            automation helps keep the issue tracker clean from issues that are
+            not actionable. Please reach out if you have more information for us
+            or you think this issue shouldn't be closed! 🙂 If you don't do so
+            within 7 days, this PR will be automatically closed.

.github/workflows/release-comments.yml

@@ -2,44 +2,20 @@ name: 📝 Comment on Release
 
 on:
   workflow_call:
-    inputs:
-      ref:
-        required: true
-        type: string
-      package_version_to_follow:
-        required: true
-        type: string
-      release_branch:
-        required: true
-        type: string
 
 jobs:
   comment:
-    name: Comment on Release
+    name: 📝 Comment on related issues and pull requests
     if: github.repository == 'remix-run/react-router'
     runs-on: ubuntu-latest
     steps:
       - name: ⬇️ Checkout repo
         uses: actions/checkout@v3
-
-      - name: ⎔ Setup node
-        uses: actions/setup-node@v3
         with:
-          node-version-file: ".nvmrc"
-          cache: "npm"
-          cache-dependency-path: scripts/release/package-lock.json
-
-      - name: 📥 Install deps
-        run: npm ci
-        working-directory: ./scripts/release
+          fetch-depth: 0
 
-      - name: 📝 Comment on issues
-        working-directory: ./scripts/release
-        run: node -r esbuild-register ./comment.ts
-        env:
-          GITHUB_REPOSITORY: ${{ github.repository }}
-          GITHUB_TOKEN: ${{ github.token }}
-          VERSION: ${{ inputs.ref }}
-          DEFAULT_BRANCH: "main"
-          RELEASE_BRANCH: ${{ inputs.release_branch }}
-          PACKAGE_VERSION_TO_FOLLOW: ${{ inputs.package_version_to_follow }}
+      - name: 📝 Comment on related issues and pull requests
+        uses: mcansh/[email protected]
+        with:
+          DIRECTORY_TO_CHECK: "./packages"
+          PACKAGE_NAME: "react-router"

.github/workflows/release.yml

@@ -55,7 +55,7 @@ jobs:
           publish: yarn run release
           createGithubReleases: false
         env:
-          GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN_SO_OTHER_ACTIONS_RUN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
   find_package_version:
@@ -80,7 +80,7 @@ jobs:
 
       - id: find_package_version
         run: |
-          package_version=$(node ./scripts/release/find-release-from-changeset.js)
+          package_version=$(node ./scripts/find-release-from-changeset.js)
           echo "package_version=${package_version}" >> $GITHUB_OUTPUT
         env:
           PACKAGE_VERSION_TO_FOLLOW: "react-router"
@@ -91,7 +91,3 @@ jobs:
     if: github.repository == 'remix-run/react-router' && needs.find_package_version.outputs.package_version != ''
     needs: [release, find_package_version]
     uses: ./.github/workflows/release-comments.yml
-    with:
-      ref: refs/tags/react-router@${{ needs.find_package_version.outputs.package_version }}
-      package_version_to_follow: "react-router"
-      release_branch: ${{ github.ref_name }}

FAQ.md

@@ -1,7 +1,8 @@
 MIT License
 
-Copyright (c) React Training 2015-2019
-Copyright (c) Remix Software 2020-2022
+Copyright (c) React Training LLC 2015-2019
+Copyright (c) Remix Software Inc. 2020-2021
+Copyright (c) Shopify Inc. 2022-2023
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.md

@@ -57,6 +57,7 @@
 - elylucas
 - emzoumpo
 - engpetermwangi
+- ericschn
 - FilipJirsak
 - frontsideair
 - fyzhu
@@ -86,10 +87,13 @@
 - JaffParker
 - jakkku
 - JakubDrozd
+- jamesrwilliams
 - janpaepke
+- jasikpark
 - jasonpaulos
 - jdufresne
 - jenseng
+- JeraldVin
 - JesusTheHun
 - jimniels
 - jmargeta
@@ -117,8 +121,10 @@
 - lordofthecactus
 - LordThi
 - loun4
+- lpaube
 - lqze
 - lukerSpringTree
+- m-dad
 - m-shojaei
 - machour
 - Manc
@@ -156,12 +162,14 @@
 - petersendidit
 - promet99
 - pyitphyoaung
+- rimian
 - RobHannay
 - rtmann
 - rubeonline
 - ryanflorence
 - ryanhiebert
 - sanketshah19
+- scarf005
 - senseibarni
 - sergiodxa
 - sgalhs

contributors.yml

@@ -26,6 +26,12 @@ interface LinkProps
 }
 
 type To = string | Partial<Path>;
+
+interface Path {
+  pathname: string;
+  search: string;
+  hash: string;
+}
 ```
 
 </details>
@@ -136,6 +142,10 @@ You can access this state value while on the "new-path" route:
 let { state } = useLocation();
 ```
 
+## `reloadDocument`
+
+The `reloadDocument` property can be used to skip client side routing and let the browser handle the transition normally (as if it were an `<a href>`).
+
 [link-native]: ./link-native
 [scrollrestoration]: ./scroll-restoration
 [history-replace-state]: https://developer.mozilla.org/en-US/docs/Web/API/History/replaceState

docs/components/link.md

@@ -120,4 +120,8 @@ Adding the `caseSensitive` prop changes the matching logic to make it case sensi
 
 When a `NavLink` is active it will automatically apply `<a aria-current="page">` to the underlying anchor tag. See [aria-current][aria-current] on MDN.
 
+## `reloadDocument`
+
+The `reloadDocument` property can be used to skip client side routing and let the browser handle the transition normally (as if it were an `<a href>`).
+
 [aria-current]: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-current

docs/components/nav-link.md

@@ -34,7 +34,7 @@ Whenever the location changes, `<Routes>` looks through all its child routes to
 </Routes>
 ```
 
-[location]: ../hook/location
+[location]: ../utils/location
 [outlet]: ./outlet
 [use-route]: ../hooks/use-routes
 [createbrowserrouter]: ../routers/create-browser-router

docs/components/routes.md

@@ -57,7 +57,7 @@ But it's still sub optimal in most cases (especially if you're code-splitting ro
 React Router takes advantage of React 18's Suspense for data fetching using the [`defer` Response][defer response] utility and [`<Await />`][await] component / [`useAsyncValue`][useasyncvalue] hook. By using these APIs, you can solve both of these problems:
 
 1. Your data is no longer on a waterfall: document -> JavaScript -> Lazy Loaded Route & data (in parallel)
-2. Your can easily switch between rendering the fallback and waiting for the data
+2. Your code can easily switch between rendering the fallback and waiting for the data
 
 Let's take a dive into how to accomplish this.