Exposed setIsHovering state setter

dist/README.md

@@ -11,7 +11,7 @@
   </a>
 </p>
 
-react-use-hoverintent is a react hook which allows you to use classic hoverintent behaviour in modern, react way.
+react-use-hoverintent is a react hook which allows you to use classic hoverintent behavior in modern, react way.
 
 "hoverIntent is a plug-in that attempts to determine the user's intent... like a crystal ball, only with mouse movement! It is similar to jQuery's hover method. However, instead of calling the handlerIn function immediately, hoverIntent waits until the user's mouse slows down enough before making the call."
 
@@ -52,40 +52,40 @@ Default `interval: 100`
 Basic usage
 
 ```javascript
-import React from 'react';
-import { useHoverIntent } from 'react-use-hoverintent';
+import React from "react";
+import { useHoverIntent } from "react-use-hoverintent";
 
 export const MyFunctionalComponent = (props) => {
   const [isHovering, ref] = useHoverIntent();
-  return <div ref={ref} className={`${isHovering ? 'hover' : ''}`}></div>;
+  return <div ref={ref} className={`${isHovering ? "hover" : ""}`}></div>;
 };
 ```
 
 With options
 
 ```javascript
-import React from 'react';
-import { useHoverIntent } from 'react-use-hoverintent';
+import React from "react";
+import { useHoverIntent } from "react-use-hoverintent";
 
 export const MyFunctionalComponent = (props) => {
   const [isHovering, ref] = useHoverIntent({
     timeout: 100,
     sensitivity: 10,
     interval: 200,
   });
-  return <div ref={ref} className={`${isHovering ? 'hover' : ''}`}></div>;
+  return <div ref={ref} className={`${isHovering ? "hover" : ""}`}></div>;
 };
 ```
 
 With ForwardRef
 
 ```js
-import React from 'react';
-import { useHoverIntent } from 'react-use-hoverintent';
+import React from "react";
+import { useHoverIntent } from "react-use-hoverintent";
 
 export const MyFunctionalComponent = React.forwardRef((props, ref) => {
   const [isHovering, intentRef] = useHoverIntent({ ref });
-  return <div ref={intentRef} className={`${isHovering ? 'hover' : ''}`}></div>;
+  return <div ref={intentRef} className={`${isHovering ? "hover" : ""}`}></div>;
 });
 ```
 
@@ -94,15 +94,15 @@ With Custom UI lib
 Check if they have `innerRef` prop or forwarded ref
 
 ```javascript
-import React from 'react';
-import { useHoverIntent } from 'react-use-hoverintent';
+import React from "react";
+import { useHoverIntent } from "react-use-hoverintent";
 
 export const MyFunctionalComponent = (props) => {
   const [isHovering, intentRef] = useHoverIntent();
   return (
     <Card
       innerRef={intentRef}
-      className={`${isHovering ? 'hover' : ''}`}
+      className={`${isHovering ? "hover" : ""}`}
     ></Card>
   );
 };

dist/index.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="react" />
+import { Dispatch, SetStateAction } from "react";
 interface optionType {
     ref?: React.Ref<HTMLElement | null>;
     sensitivity?: number;
     interval?: number;
     timeout?: number;
 }
-export declare function useHoverIntent<T = HTMLElement>(options?: optionType): [boolean, React.RefObject<HTMLElement & T>];
+export declare const useHoverIntent: <T>(options?: optionType | undefined) => [boolean, Dispatch<SetStateAction<boolean>>, import("react").RefObject<HTMLElement & T>];
 export {};