;
}
`

Scroll containers are identified with a 'scrollKey'. There should only be one element associated with a given key for any given location. Think of it as similar to React's key prop, in that it provides a stable identity for an element across renders.

$3

You can provide a custom shouldUpdateScroll callback as a prop to . This callback receives the previous and the current renderArgs.

The callback can return:

- a falsy value to suppress updating the scroll position
- a position array of x and y, such as [0, 100], to scroll to that position
- a string with the id or name of an element, to scroll to that element
- a truthy value to emulate the browser default scroll behavior

`js
const shouldUpdateScrollByPathname = (prevRenderArgs, { location }) =>
!prevRenderArgs || location.pathname !== prevRenderArgs.location.pathname;

const shouldUpdateScrollByRoute = (prevRenderArgs, { routes }) => {
if (routes.some((route) => route.ignoreScrollBehavior)) {
return false;
}

if (routes.some((route) => route.scrollToTop)) {
return [0, 0];
}

return true;
};

const render = (renderArgs) => (
shouldUpdateScroll={shouldUpdateScrollByPathname}
renderArgs={renderArgs}
>
{/ ... /}

);
`

You can customize even further by providing a createScrollBehavior callback that creates the scroll behavior object. This allows using a custom subclass of ScrollBehavior from scroll-behavior with custom logic. When using a custom createScrollBehavior callback, you can continue to specify the shouldUpdateScroll callback as above.

`js
const render = (renderArgs) => (
createScrollBehavior={(config) => new MyScrollBehavior(config)}
renderArgs={renderArgs}
>
{/ ... /}

);
``

[npm-badge]: https://img.shields.io/npm/v/found-scroll.svg
[npm]: https://www.npmjs.org/package/found-scroll