useHover

API Reference

useHover

Provides state and event handlers for listening to hover events.

function useHover(): readonly [boolean, { readonly onMouseEnter: () => void; readonly onMouseLeave: () => void; }]

Returns

readonly [boolean, { readonly onMouseEnter: () => void; readonly onMouseLeave: () => void; }]

Examples

  • useHover
    import { useHover } from 'hooks'
    
    export default function Example() {
      const [hover, hoverProps] = useHover()
    
      return (
        <div {...hoverProps}>
          Hover me! {hover ? 'Hovered' : 'Not hovered'}
        </div>
      )
    }