rfr

redux-first-router-scroll-container

think of your app in states not routes (and, yes, while keeping the address bar in sync)

Showing:

Popularity

Downloads/wk

8

GitHub Stars

3

Maintenance

Last Commit

4yrs ago

Contributors

0

Package

Dependencies

2

Size (min+gzip)

1.0KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

redux-first-router-scroll-container

Use <ScrollContainer> to facilitate scroll restoration for elements other than window. Each <ScrollContainer> must be given a unique scrollKey, and can be given an optional shouldUpdateScroll callback that behaves the same as in redux-first-router-restore-scroll.

You must use this component in conjunction with redux-first-router-restore-scroll and of course redux-first-router itself. Once both are installed, you can simply use the component as shown below to wrap your scrollable element. No context <Provider> element is needed to wrap your app.

import ScrollContainer from 'redux-first-router-scroll-container';

const MyComponent => 
  <ScrollContainer
    scrollKey={'my-unique-name'}
    shouldUpdateScroll={shouldUpdateScroll}
  >
    <MyScrollableComponent />
  </ScrollContainer>

a unique name is needed for each individual ScrollContainer so that multiple of them can be correctly restored.

Caveats

  • <ScrollContainer> does not support on-the-fly changes to scrollKey or to the DOM node for its child.

Thanks

This package is a port of the corresponding component within https://github.com/taion/react-router-scroll . Thanks for pioneering this route, particularly @taion for the amazing scroll-behavior package which supports all such components.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100