Skip to content

Commit

Permalink
Added info about onScroll event to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
unknown authored and unknown committed Feb 2, 2016
1 parent f356c16 commit dcf47ad
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,24 @@ then open [http://localhost:8003](http://localhost:80003).
vertical={Boolean}
verticalContainerStyle={Object}
verticalScrollbarStyle={Object}
onScroll={(value) => {}}
>
```

#### speed
Scroll speed applied to mouse wheel event.
**Default: 1**

#### onScroll
`onScroll(value: Object)` event which can notify the parent component when the container scrolls.
- `value: Object` - informations about current position
- `value.leftPosition: Number` - content left position (distance in pixels from the left side of container)
- `value.topPosition: Number` - content top position (distance in pixels from the top of container)
- `value.containerHeight: Number` - container height
- `value.containerWidth: Number` - container width
- `value.realHeight: Number` - real content height
- `value.realWidth: Number` - real content width

#### className
CSS class names added to main scroll area component.

Expand Down

0 comments on commit dcf47ad

Please sign in to comment.