Fix scroll restoration when redirecting in an action

[brophdawg11]

Closes #9577

This also introduces <Form preventScrollReset> and fixes an underlying bug where we were preventing restore on submissions when we should be preventing reset 😬 . We always restore if we have a previous known position (which we never do by default because we use location.key).

New semantics:

// 1. Default behavior

// Resets scroll
<Link />
<Form />
<Form method="get" />
<Form method="post" /> /* action redirects */

// Does not reset scroll
<Form method="post" /> /* action does not redirect */


// 2. Override default

// does not reset scroll
<Link preventScrollReset />
<Form preventScrollReset />
<Form preventScrollReset method="get" />
<Form preventScrollReset method="post" /> /* action redirects */
<Form preventScrollReset method="post" /> /* action does not redirect */

[changeset-bot]

🦋 Changeset detected

Latest commit: 4d7ed68

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	Patch
react-router-dom	Minor
react-router	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]

We always try to restore - that never should have been conditional on submissions

[brophdawg11]

By default, don't reset on non-redirecting submission navigations

[nrako]

@brophdawg11 – this is great but unfortunately preventScrollReset doesn't work on redirect when the FormImpl is fetcher.Form, I've opened an issue #9961 and put up this stackblitz to reproduce the issue https://stackblitz.com/edit/node-sbijvk?file=app/routes/index.tsx

[brophdawg11]

Thanks @nrako, I transferred that issue to the react router repo and will try to take a look this week 👍