Skip to main content

IdleTimer

Definition

IdleTimer is a component for detecting idle Time of the user for given miliseconds in idleTime property.

IdleTimer has 2 methods to call, start and clearTimer.

  • IdleTimer.start() method creates a timer Instance.
  • IdleTimer.clearTimer() method clears the timer Instance.

Props

AttributeDescriptionTypeDefault
detectMouseMoveDetectMouseMove: detect as activity any mouse movementsbooleanfalse
detectKeyPressDetect as activity any keypressbooleanfalse
idleTimeIdleTime of the user in milisecondsnumberundefined
visibleVisibility of IdleTimer componentbooleantrue

Events

AttributeDescription
TimeOutEvent triggered on user's idle Time for specified milliseconds in the idleTime property.

Example usage of component:

IdleTimer