From dcf47ada50e77b02e790e8def1185bd87b47380f Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 2 Feb 2016 12:30:08 +0100 Subject: [PATCH] Added info about onScroll event to Readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 4f8b077..82b54f6 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,7 @@ then open [http://localhost:8003](http://localhost:80003). vertical={Boolean} verticalContainerStyle={Object} verticalScrollbarStyle={Object} + onScroll={(value) => {}} > ``` @@ -82,6 +83,16 @@ then open [http://localhost:8003](http://localhost:80003). 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.