@darius_rosendahl/react-use-hoverintent

React useHoverIntent

react-use-hoverintent is a react hook which allows you to use classic hoverintent behaviour in modern, react way.

"hoverIntent is a plug-in that attempts to determine the user's intent... like a crystal ball, only with mouse movement! It is similar to jQuery's hover method. However, instead of calling the handlerIn function immediately, hoverIntent waits until the user's mouse slows down enough before making the call."

Built with typescript, with official typing, with zero dependency, transpiled to es5.

Inspired by jquery-hoverintent react-hoverintent

Installation

yarn add react-use-hoverintent

npm install react-use-hoverintent

Options

ref: the react element ref which you want hoverintent to be applied, required.

timeout : A simple delay, in milliseconds, before the onMouseOut callback is fired. If the user mouses back over the element before the timeout has expired the onMouseOut callback will not be called (nor will the onMouseOver callback 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.

Default timeout: 0

sensitivity : If the mouse travels fewer than this number of pixels between polling intervals, then the onMouseOver callback 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.

Default sensitivity: 6

interval : 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 onMouseOut callback can be called is after a single polling interval. Setting the polling interval higher will increase the delay before the first possible onMouseOver call, but also increases the time to the next point of comparison.

Default interval: 100

Usage

Basic usage

import React from 'react';
import { useHoverIntent } from 'react-use-hoverintent';

export const MyFunctionalComponent = (props) => {
  const [isHovering, ref] = useHoverIntent();
  return <div ref={ref} className={`${isHovering ? 'hover' : ''}`}></div>;
};

With options

import React from 'react';
import { useHoverIntent } from 'react-use-hoverintent';

export const MyFunctionalComponent = (props) => {
  const [isHovering, ref] = useHoverIntent({
    timeout: 100,
    sensitivity: 10,
    interval: 200,
  });
  return <div ref={ref} className={`${isHovering ? 'hover' : ''}`}></div>;
};

With ForwardRef

import React from 'react';
import { useHoverIntent } from 'react-use-hoverintent';

export const MyFunctionalComponent = React.forwardRef((props, ref) => {
  const [isHovering, intentRef] = useHoverIntent({ ref });
  return <div ref={intentRef} className={`${isHovering ? 'hover' : ''}`}></div>;
});

With Custom UI lib

Check if they have innerRef prop or forwarded ref

import React from 'react';
import { useHoverIntent } from 'react-use-hoverintent';

export const MyFunctionalComponent = (props) => {
  const [isHovering, intentRef] = useHoverIntent();
  return (
    <Card
      innerRef={intentRef}
      className={`${isHovering ? 'hover' : ''}`}
    ></Card>
  );
};

License

MIT