use-hover

Detects if given element is hovered

Usage

Put mouse over me please

import { useHover } from '@mantine/hooks';

function Demo() {
  const { hovered, ref } = useHover();
  return (
    <div ref={ref}>
      {hovered ? 'I am hovered' : 'Put mouse over me please'}
    </div>
  );
}

Definition

interface UseHoverReturnValue<T extends HTMLElement = any> {
  hovered: boolean;
  ref: React.RefCallback<T | null>;
}

function useHover<T extends HTMLElement = any>(): UseHoverReturnValue<T>

Exported types

UseHoverReturnValue type is exported from @mantine/hooks package, you can import it in your application:

import type { UseHoverReturnValue } from '@mantine/hooks';