@react-hook/window-scroll - npm Package Compare versions

Comparing version 1.1.2 to 1.1.3

package.json

		{
		"name": "@react-hook/window-scroll",
		"version": "1.1.2",
		"version": "1.1.3",
		"homepage": "https://github.com/jaredLunde/react-hook/tree/master/packages/window-scroll#readme",
		@@ -87,3 +87,3 @@ "repository": "github:jaredLunde/react-hook",
		"dependencies": {
		"@react-hook/throttle": "^2.1.0"
		"@react-hook/throttle": "^2.1.2"
		},
		@@ -90,0 +90,0 @@ "peerDependencies": {

README.md

		@@ -26,3 +26,5 @@ <hr>

		A React hook for updating components when the scroll position of the window on the y-axis changes
		A React hook for updating components when the scroll position of the window on the y-axis changes.
		This hook throttles updates to the scroll position using [useThrottle()](https://github.com/jaredLunde/react-hook/tree/master/packages/throttle)
		at `30fps` by default, but this rate is configurable.

		@@ -44,7 +46,9 @@ ## Quick Start

		A hook that performantly updates its scroll position at a constant frame rate.

		#### Arguments

		\| \| Type \| Default \| Description \|
		\| --- \| -------- \| ------- \| ------------------------------------------------------------------------------- \|
		\| fps \| `number` \| `30` \| Defines the rate in frames per second with which the scroll position is updated \|
		\| \| Type \| Default \| Description \|
		\| --- \| -------- \| ------- \| ----------------------------------------------------------------------------- \|
		\| fps \| `number` \| `30` \| Defines the rate in frames per second at which the scroll position is updated \|

		@@ -51,0 +55,0 @@ #### Returns `scrollY: number`

New alerts