Skip to content

useHover

This hook returns whether the target element is hovered or not, and it can use a delay value as well for both hover and unhover events.

Options

NameTypeDescription
refRefObjectthe target element reference.
delayNumber or Objecta delay value for both hover and unhover events in ms.

Return Values

NameTypeDescription
refRefObjectthe target element reference.
isHoveredBooleanwhether the element is hovered or not.

Example Usage

tsx
import { useHover } from 'react-pre-hooks';

export default function Example() {
  const { ref, isHovered } = useHover({ delay: { hover: 300, unhover: 750 } });

  return (
    <main>
      <div ref={ref}>
        {isHovered && <span>This is a tooltip!</span>}
        {isHovered ? 'unhover' : 'hover'}
      </div>
    </main>
  );
}
import { useHover } from 'react-pre-hooks';

export default function Example() {
  const { ref, isHovered } = useHover({ delay: { hover: 300, unhover: 750 } });

  return (
    <main>
      <div ref={ref}>
        {isHovered && <span>This is a tooltip!</span>}
        {isHovered ? 'unhover' : 'hover'}
      </div>
    </main>
  );
}

Released under the MIT License.