moxystudio / next-router-scroll Goto Github PK

https://github.com/vercel/next.js/pull/13914/files#diff-5eff10c96fa6858c659318492c4cf7f7

It seems that the X and Y coordinates are being stored in the router state, meaning perhaps we can leverage those instead of saving into the local storage.

Hi there team!

Your package here is stupendous and valuable, so thank you for your hard work! This topic is, somehow, not super easy for some reason. You'd think, the browser should just do its thing and ✅ ?

A common use case that I ran into is waiting for a specific element to render before updateScroll is called. I read over the README and I read over your tests (thanks for adding those!). Unfortunately, I couldn't quite piece together just "how" registering an element would allow me to "wait for it to render" before updating scroll.

So what I did instead was use the update ref pattern that React outlines here.

My implementation ended up looking a little like this:

const MyComponent = () => {
  const divRef = useCallback(
    (node) => {
      if (node !== null) {
        updateScroll();
      }
    },
    [updateScroll]
  );

  return (
    <div ref={divRef}>hi</div>
  );
}

This ended up working pretty well for me, and allowed me to explicitly wait for a node to appear before updating scroll.

The reason I'm opening this issue, is I'm wondering if the README could be more clear about how to use registerElement and updateScroll together. If the intended use case for those is not similar to the above implementation, would it be valuable to add an example that showed how to do something like this?

Thanks again for all your hard work!

Please tell me about the plan to open the declaration file for typescript user.

If you don't have any plan for now, then can I pull request the declare file?

Thank you for your attention.

Will next-router-scroll be updated so it is compatible with Next.js version 12? Currently peer and dev dependencies are atmost version 11.