1.1.0 • Published 4 years ago

@sook/use-hover v1.1.0

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

@sook/use-hover

React Hook to detect a hover on an any React Element

Installation

yarn

yarn add @sook/use-hover

npm

npm i @sook/use-hover

Usage

import React from "react";
import useHover from "@sook/use-hover";

function App() {
  const onHover = () => console.log("Somebody hovered!");
  const markedRef = useClick(onHover);
  return <h1 ref={markedRef}>Hello sook</h1>;
}

Arguments

ArgumentTypeDescriptionRequired
onHoverfunctionFunction to be called when the element is hoveredyes

Return

Return valueTypeDescriptionDefault value
refReact RefA React Ref listening to the hover event, add it to any elementnull