Support conditional scroll depending on the Link state

[binajmen]

Upon @machour suggestion in #186 (comment)

@dani-mp The best thing would be to open a new discussion to bring the subject back to life.

I'd like to take the time to bring back the subject back to life as I was myself facing the same situation today.

The suggestion that was originally made by @wladiston is the following:

diff --git a/node_modules/@remix-run/react/esm/scroll-restoration.js b/node_modules/@remix-run/react/esm/scroll-restoration.js
index 3f5cc5f..1843e8f 100644
--- a/node_modules/@remix-run/react/esm/scroll-restoration.js
+++ b/node_modules/@remix-run/react/esm/scroll-restoration.js
@@ -126,6 +126,15 @@ function useScrollRestoration() {
       } // otherwise go to the top on new locations
 
 
+      if (
+        location.state &&
+        typeof location.state === "object" &&
+        location.state.scroll === false
+      ) {
+        return;
+      } // PATCH: allow to disable scroll restoration by passing { scroll: false } in Link state
+
+
       window.scrollTo(0, 0);
     }, [location]);
   }

That way, one can decide to dismiss any scroll manipulation when following a Link with a scroll state set to false:

<Link to={...} state={{ scroll: false }} />