react-idle-timer - npm Package Compare versions

Comparing version 4.0.1 to 4.0.2

CHANGELOG.md

@@ -22,3 +22,1 @@ # 4.0.0
 - Removed built in date formatter.
-
-# 2.0.0

package.json

 {
   "name": "react-idle-timer",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Activity detection for React.js",
@@ -5,0 +5,0 @@ "main": "build/index.js",

README.md

@@ -25,3 +25,3 @@ # React Idle Timer
 
-For the full patch notes please refer to the [CHANGELOG](https://github.com/SupremeTechnopriest/react-idle-timer/blob/master/example/src/CHANGELOG.md)
+For the full patch notes please refer to the [CHANGELOG](https://github.com/SupremeTechnopriest/react-idle-timer/blob/master/CHANGELOG.md)
 
@@ -94,10 +94,10 @@ ## Installation
 ### Props
-- **timeout** {*Number*} - Idle timeout in milliseconds
-- **events** {*Array*} - Events to bind. See [default events](https://)
-- **idleAction** {*Function*} - Function to call on idle
-- **activeAction** {*Function*} - Function to call on active
-- **element** {*Object*} - Defaults to document, may pass a ref to another element
+- **timeout** {*Number*} - Idle timeout in milliseconds.
+- **events** {*Array*} - Events to bind. See [default events](https://github.com/SupremeTechnopriest/react-idle-timer/blob/master/src/index.js#L36-L47) for list of defaults.
+- **idleAction** {*Function*} - Function to call on idle.
+- **activeAction** {*Function*} - Function to call on active.
+- **element** {*Object*} - Defaults to document, may pass a ref to another element.
 - **startOnMount** {*Boolean*} - Start the timer on component load.  Defaults to `true`. Set to false to wait for user action before starting timer.
-- **passive** {*Boolean*} - Bind events in passive mode. Defaults to `true`. Set to false to explicitly set to active mode.
-- **capture** {*Boolean*} - Capture events. Defaults to `true`
+- **passive** {*Boolean*} - Bind events in [passive](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener) mode. Defaults to `true`.
+- **capture** {*Boolean*} - Bind events in [capture](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener) mode. Defaults to `true`.
 
@@ -104,0 +104,0 @@ ### Methods

No alert changes

Improved metrics

Total package byte prevSize

46050

0.47%

No dependency changes