Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
VikLiegostaiev committed Oct 22, 2020
1 parent f688d7b commit 8bc83d8
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Simple React component for smoothy full-page scolling.

### New beta version 2.0.6-beta released!!!
### New beta version 2.0.10-beta released!!!

### Demo

Expand Down Expand Up @@ -40,16 +40,17 @@ Example is in demo/src.
| Property | Type | Description | Default Value |
| ------------- | ---- | ----------- | ------- |
| animationTimer | number | Animation duration in milliseconds | 1000 |
| animationTimerBuffer | number | Animation buffer timing | 200 |
| blockScrollUp | bool | block scroll up | false |
| blockScrollDown | bool | block scroll down | false |
| containerHeight | number/string | height of react-page-scroller element | 100vh |
| containerWidth | number/string | width of react-page-scroller element | 100vw |
| customPageNumber | number | external selected page, number of pages should start from 0, should be combined with pageOnChange usage (see example in demo/src/FullPage.js for more information). This prop was introduced as a replacement for "goToPage" method from legacy version | |
| handleScrollUnavailable | function | callback, is calling when someone tries to scroll over last or first child component | |
| pageOnChange | function | callback after page was scrolled | |
| renderAllPagesOnFirstRender | bool | flag for render all pages at first render of component | |
| transitionTimingFunction | String | CSS transition timing function name | ease-in-out |
| animationTimerBuffer | number | Animation buffer timing | 200 |
| handleScrollUnavailable | function | callback, is calling when someone tries to scroll over last or first child component | |
| onBeforePageScroll | function | callback before page scroll occured | |
| pageOnChange | function | callback after page was scrolled | |

## Dependencies

Expand Down

0 comments on commit 8bc83d8

Please sign in to comment.