Skip to content

Commit 04c8950

Browse files
committed
Update README to include more description for props
1 parent c3c241f commit 04c8950

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ In addition to these properties, all other standard React properites like `class
8282
`key`, etc. can be passed in as well and will be applied to the `<div>` that will
8383
be rendered by the `ScrollTrigger`.
8484

85-
* `component` - Node (Default: `div`)
86-
* `throttleResize` - Number (Default: `100`)
87-
* `throttleScroll` - Number (Default: `100`)
88-
* `triggerOnLoad` - Boolean (Default: `true`)
89-
* `onEnter` - Callback `({progress, velocity}, ref) => {}`
90-
* `onExit` - Callback `({progress, velocity}, ref) => {}`
91-
* `onProgress` - Callback `({progress, velocity}, ref) => {}`
85+
* `component:Element | String` - React component or HTMLElement to render as the wrapper for the `ScrollTrigger` (Default: `div`)
86+
* `throttleResize:Number` - Delay to throttle `resize` calls in milliseconds (Default: `100`)
87+
* `throttleScroll:Number` - Delay to throttle `scroll` calls in milliseconds (Default: `100`)
88+
* `triggerOnLoad:Boolean` - Whether or not to trigger the `onEnter` callback on mount (Default: `true`)
89+
* `onEnter:Function` - Called when the component enters the viewport `({progress, velocity}, ref) => {}`
90+
* `onExit:Function` - Called when the component exits the viewport `({progress, velocity}, ref) => {}`
91+
* `onProgress:Function` - Called while the component progresses through the viewport `({progress, velocity}, ref) => {}`
9292

9393
## License
9494

0 commit comments

Comments
 (0)