Hover Intent Detection jQuery Plugin

hoverIntent is a plugin that tries to determine a user’s intent…like a crystal ball, just with a mouse movement! It is similar to jQuery’s scroll method.

However, instead of calling the handlerIn function immediately, hoverIntent waits for the user’s mouse to slow down enough before making the call.

How to make use of it:

1. Load the additional JavaScript file “jquery.hoverIntent.js” after the jQuery JavaScript library.

<script src="//code.jquery.com/jquery.min.js"></script>
<script src="jquery.hoverIntent.js"></script>

2. Basic usage is just like the .hover() method.

.hoverIntent( handlerIn, handlerOut )
.hoverIntent( handlerInOut )

3. Primary use with event authorization.

.hoverIntent( handlerIn, handlerOut, selector )
.hoverIntent( handlerInOut, selector )

4. Activate the plugin using the basic configuration object.

.hoverIntent({

  // The number of milliseconds hoverIntent waits between reading/comparing mouse coordinates. 
  // When the user's mouse first enters the element its coordinates are recorded. 
  // The soonest the "over" function can be called is after a single polling interval. 
  // Setting the polling interval higher will increase the delay before the first possible "over" call, but also increases the time to the next point of comparison. 
  interval: 100,

  // If the mouse travels fewer than this number of pixels between polling intervals, then the "over" function will be called. 
  // With the minimum sensitivity threshold of 1, the mouse must not move between polling intervals. 
  // With higher sensitivity thresholds you are more likely to receive a false positive. Note that hoverIntent r7 and earlier perform this comparison using rectilinear distance, whereas more recent versions compare against Euclidean (straight-line) distance for better accuracy and intuition. 
  // If you are upgrading from an older version, you may want to verify that the desired behavior is preserved. 
  sensitivity: 6,

  // A simple delay, in milliseconds, before the "out" function is called. 
  // If the user mouses back over the element before the timeout has expired the "out" function will not be called (nor will the "over" function be called). 
  // This is primarily to protect against sloppy/human mousing trajectories that temporarily (and unintentionally) take the user off of the target element... giving them time to return. 
  timeout: 0
  
})

Hover Intent Detection Plugin With jQuery Github