Add behavior prop to <ScrollRestoration />

[h3rmanj]

Non-breaking continuation of #10318.

Adds an optional behavior prop to <ScrollRestoration /> that are passed through to the scrollTo calls. This allows the user to specify a specific behavior for scroll restoration, while setting a different value globally with css.

The original PR was closed due to being breaking, and not going through a proposal for considering more generic behavior. A proposal was opened in #10328, but hasn't received any more activity for a year. Due to the inactivity, I feel the ScrollRestoration works fine other than missing a way to specify behavior, and a generic approach seems unnecessary.

[changeset-bot]

🦋 Changeset detected

Latest commit: b9fd4f3

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

This PR includes changesets to release 4 packages

Name	Type
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

[remix-cla-bot]

Hi @h3rmanj,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

[h3rmanj]

Seems to add 0.07 kB to dist bundle and 0.08 kB to umd bundle, so I had to bump the filesize property in package.json from 17.2 kB to 17.3 kB. Not sure if that's the proper way to do it though.