1.0.0 • Published 4 years ago

@ej-hooks/use-hover v1.0.0

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

@ej-hooks/use-hover

React Hook to detect a hover on an any React Element

Installation

yarn

yarn add @ej-hooks/use-hover

npm

npm i @ej-hooks/use-hover

Usage

import React from 'react';
import useHover from '@ej-hooks/use-hover';
function App() {
  const onHover = () => console.log('Somebody hovered!');
  const makedRef = useHover(onHover);
  return <h1 ref={makedRef}>Hello Hooks</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