Add support for replace() redirects

[brophdawg11]

Builds off of #11100 and adds the new replace() redirect API

Closes #10606

[changeset-bot]

🦋 Changeset detected

Latest commit: cbf49e8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
@remix-run/router	Minor
react-router	Minor
react-router-dom	Minor
react-router-dom-v5-compat	Minor
react-router-native	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[brophdawg11]

Similar to redirectDocument - this is just a wrapper with a custom internal header

[github-actions]

🤖 Hello there,

We just published version 6.26.0-pre.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

[github-actions]

🤖 Hello there,

We just published version 6.26.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

[DreierF]

I gave it a try, but it does not quite behave like I would have expected. Not sure though if this is a misunderstanding on my side or a bug.

Minimal reproduction: https://stackblitz.com/edit/github-efe1i6?file=src%2Fapp.tsx

Steps to reproduce:

• Open the preview in a new tab
• Click on "Go to 1"
• Click on "Go to 2"
• Observe that the filter search param is added as expected
• Then navigate back in the browser

Expected
I get back to the previous page that shows "Go to 2"

Actual
I get back to the initial "Go to 1" because the replace replaces the history entry I'm coming from instead of the entry that I'm navigating to/loading data for.

@brophdawg11 Could you take a look whether this is expected?
I can also file a bug ticket if this is not expected.

[brophdawg11]

This is functioning as expected because loaders run before the history stack is updated. So the loader for /2 is running while history is on /1 and thus by using replace you are replacing the /1 entry in the history stack. This is done intentionally so that if you are redirect-ing you don't see the URL flickering between intermediate states and just goes from the original URL to the final redirected URL.

If you want the history stack to be / -> /1 -> /2?filter=abc then you don't need to use replace and you can just use a normal redirect and then the back button will go to /1.