feat(router): configuration of scroll behavior for Link and useRouter

[tylersayshi]

follow up for: #1098 (comment)

cc @wesbos thanks for this call out

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Updated (UTC)
waku	⬜️ Ignored (Inspect)	Visit Preview	Feb 17, 2025 7:07am

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

[tylersayshi]

@dai-shi all very true. I didn't give the api enough though. How about something like this:

/**
 * Indicates that the link should not scroll when clicked. By default, waku will 
 * scroll when the path changes. This is a way to explicitly not change the scroll 
 * position on navigation.
 */
 dontScroll?: boolean;

alternate names: disableScroll or noScroll

Let me know what you think and I'll change the code accordingly

[dai-shi]

@tylersayshi I'm afraid my comment wasn't very clear.

I'm actually fine with scroll naming, but the options are:

• undefined (default): scroll based on newPath check (= current Link behavior)
• false: no scroll
• true: always scroll

[dai-shi]

LGTM