@trashpanda001/helpers
    Preparing search index...

    Function useHover

    • This hook sets isHovered if its ref is hovered. The ref should be attached to the element you're interested in. An optional onHover can be passed that is invoked on/off hover.

      Type Parameters

      • T extends HTMLElement = HTMLElement

      Parameters

      • OptionalonHover: (hovered: boolean) => void

        optional callback (first argument is true if hovered)

      Returns { isHovered: boolean; ref: RefObject<null | T> }

      object with ref and isHovered properties

      Listen for hover events on an element.

      import { useHover } from "@trashpanda001/helpers/react"

      function Component() {
      const { ref, isHovered } = useHover((hovered) => {
      console.log(`Callback received ${hovered}`)
      })
      return <div ref={ref}>{isHovered ? "Hovering" : "Not hovering"} over this element.</div>
      }