qol-hooks
Version:
A collection of React hooks to improve the quality of life of developers.
19 lines (18 loc) • 502 B
TypeScript
import { RefObject } from "react";
/**
* Custom hook to track hover state of an element.
* @returns A tuple containing a ref object and a boolean indicating whether the element is hovered.
*
* @example```tsx
* const Component = () => {
* const [hoverRef, isHovered] = useHover();
*
* return (
* <div ref={hoverRef}>
* {isHovered ? "Hovered" : "Not Hovered"}
* </div>
* )};
* ```
*/
declare function useHover(): [RefObject<HTMLElement>, boolean];
export default useHover;