1.0.6 • Published 2 years ago

@mm1802/react-scroll v1.0.6

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

INSTALL

npm i @mm1802/react-scroll

USAGE OF SCROLLPROVIDER

<ScrollProvider
    scrolling={(obj) => {}}
    onScrollToEnd={() => {}}
    onScrollToTop={() => {}}
    onScrollUp={(obj) => {}}
    onScrollDown={(obj) => {}}>
    <!-- ELEMENTS -->
</ScrollProvider>
PROPERTYTYPEDESCRIPTION
children--
scrolling(status: IScrollObject) => voidtrigger on scrolling
onScrollToEnd( ) => void;trigger on scrolled to end
onScrollToTop( ) => void;trigger on scrolled to top
onScrollUp(obj: IScrollObject) => void;trigger on scrolling up
onScrollDown(obj: IScrollObject) => void;trigger on scrolling down

USAGE OF SCROLLPROVIDER HOOK

import { useScrollProvider } from '@mm1802/react-scroll';
const ctx = useScrollProvider();
PROPERTYTYPEDESCRIPTION
scrollPositionnumbervalue of scorlled position
scrollProviderScrollToEndbooleanscrolled to end
scrollProviderScrollToTopbooleanscrolled to top
scrollDirectionUP - DOWNscrolling direction
scrollTo(top: number) => voidscroll to handler
1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago