Merge pull request #16 from zJaaal/dev

Added documentation to the hooks

Author: zJaaal

src/lib/hooks/useDirection.ts

@@ -3,6 +3,10 @@ import ScrollContext from "../context/ScrollContext";
 import { Directions } from "../types";
 import validateScrollValue from "../utils/validateScrollValue";
 
+/**
+ * @description This hooks calculates the direction of your scroll
+ * @returns direction: "UP" or "DOWN"
+ */
 const useDirection = () => {
   const scrollState = useContext(ScrollContext);
   const [direction, setDirection] = useState(Directions.down);

src/lib/hooks/useProximity.ts

@@ -8,6 +8,11 @@ import React, {
 import ScrollContext from "../context/ScrollContext";
 import validateScrollValue from "../utils/validateScrollValue";
 
+/**
+ * @description This hooks returns the proximity of the viewport from the component.
+ * @param ref A reference to the HTMLElement
+ * @returns A float value that represents the proximity to the component. The closer to 1 the closer is the middle of the screen from the component.
+ */
 const useProximity = (ref: RefObject<any>) => {
   const scrollState = useContext(ScrollContext);