react-idle-timer - npm Package Versions

5.4.1

🐞 Bug Fixes

• Fix a bug where workerTimers were not mocked by createMocks().
• Fix a bug where reset was not resetting the start time affecting getTotalActiveTime(). #272

5.4.0

⚡️ Features

• Add getTabId() method.
• Add activate() method. #263

🐞 Bug Fixes

• Fix a bug where events would leak when crossTab is enabled causing bad performance when many tabs are open. #247

5.3.0

✨ Enhancements

• The reset method now respects startManually property. It will no longer automatically call onActive.
• Export DEFAULT_EVENTS for easy extension of events. #260

🐞 Bug Fixes

• The getRemainingTime method now always returns the time to idle instead of time to prompt and then time to idle. #256
• Debounced onAction callbacks will automatically be cancelled on idle. #255

5.2.0

✨ Enhancements

• Add name property to support multiple instances when crossTab is enabled.

5.1.3

🐞 Bug Fixes

• Use builtin Omit over utility-types Subtract. Fixes missing dependency error.

5.1.2

✨ Enhancements

• Forward ref on withIdleTimer.

5.1.1

🐞 Bug Fixes

• Add missing React import in withIdleTimer.

5.1.0

⚡️ Features

• New implementation of Leader Election.

Due to popular request, Leader Election has returned in version 5.1.0. While the old implementation was incompatible with v5, this new implementation is compatible. A new property leaderElection is exposed to enable the feature. The major difference between the v4 and v5 implementation is that in v5 events are not isolated to your leader tab automatically. You will need to call the isLeader method inside your event handlers. See the docs for more information.

5.0.0

Version 5 is a complete, from scratch, typescript rewrite. A lot of effort went into this release. If you find this package useful and have the means, please consider a small donation!

⚡️ Features

• Add built in prompt handling.
• Add immediateEvents property.
• Add cross tab custom message broadcasting.
• New higher order component withIdleTimer.
• New provider IdleTimerProvider.
• Add syncTimers property.

✨ Enhancements

• Timeouts and Intervals are now hoisted into a web worker to bypass browser background throttles.
• Rewrite crossTab from the ground up. The new implementation is much smaller and more efficient.
• Cross Tab options simplified.
• All callbacks and methods are now memoized.

🐞 Bug Fixes

• All property values can now be dynamically updated.
• Fix getTotalActiveTime returning negative value.
• Fix sending message on closed channel error.

🔥 Code Removal

• Remove capture property.
• Remove passive property.
• Remove emitOnAllTabs property.
• Remove isLeader method.

📝 Documentation

• New documentation site.
• Add contribution guide.
• Add issue and pull request templates.

⬆️ Update Dependencies

• Updated for React 17.
• Updated all dependencies.

4.6.4

🐞 Bug Fixes

• Make ref optional in typedef.

4.6.3

✨ Enhancements

• Export a bundle for modern browsers.

🐞 Bug Fixes

• Add missing ref to TypeScript definitions.
• Fix a bug where reset would not propagate cross tab.

4.6.2

✨ Enhancements

• Allow for dynamically setting onActive and onIdle event handlers in conjunction with cross tab event reconciliation.

4.6.1

✨ Enhancements

• When emitOnAllTabs is set to true, start, reset, pause and resume will be called on all tabs.
• Calling reset will now automatically fire onActive while calling start will not. Otherwise these two methods are functionally equivalent.

🐞 Bug Fixes

• Fix an issue where the localStorage method would not call idle if there wasn't any user activity on the page.
• Fix an issue where the TabManager would not deregister itself when the tab was closed if it was not the leader tab.

🚿 Clean up

• Fix a type-o in propTypes, typescript definitions and docs.