From c826ad66df066b90b09009f2f4b83b56d018436e Mon Sep 17 00:00:00 2001
From: Armand Philippot <git@armandphilippot.com>
Date: Wed, 15 Nov 2023 16:37:16 +0100
Subject: refactor(hooks): rewrite useScrollPosition hook

* return the scroll position (both X and Y)
* no longer accepts arguments
* add tests
---
 src/utils/hooks/use-scroll-position/index.ts       |  1 +
 .../use-scroll-position.test.ts                    | 25 +++++++++++++++++
 .../use-scroll-position/use-scroll-position.ts     | 31 ++++++++++++++++++++++
 3 files changed, 57 insertions(+)
 create mode 100644 src/utils/hooks/use-scroll-position/index.ts
 create mode 100644 src/utils/hooks/use-scroll-position/use-scroll-position.test.ts
 create mode 100644 src/utils/hooks/use-scroll-position/use-scroll-position.ts

(limited to 'src/utils/hooks/use-scroll-position')

diff --git a/src/utils/hooks/use-scroll-position/index.ts b/src/utils/hooks/use-scroll-position/index.ts
new file mode 100644
index 0000000..8c11c1e
--- /dev/null
+++ b/src/utils/hooks/use-scroll-position/index.ts
@@ -0,0 +1 @@
+export * from './use-scroll-position';
diff --git a/src/utils/hooks/use-scroll-position/use-scroll-position.test.ts b/src/utils/hooks/use-scroll-position/use-scroll-position.test.ts
new file mode 100644
index 0000000..49370ae
--- /dev/null
+++ b/src/utils/hooks/use-scroll-position/use-scroll-position.test.ts
@@ -0,0 +1,25 @@
+import { describe, expect, it } from '@jest/globals';
+import { fireEvent, renderHook } from '@testing-library/react';
+import { type ScrollPosition, useScrollPosition } from './use-scroll-position';
+
+describe('useScrollPosition', () => {
+  it('returns the scroll position based on window', () => {
+    const { result } = renderHook(() => useScrollPosition());
+
+    expect(result.current.x).toBe(0);
+    expect(result.current.y).toBe(0);
+
+    const newPos: ScrollPosition = {
+      x: 50,
+      y: 100,
+    };
+
+    fireEvent.scroll(window, { target: { scrollX: newPos.x } });
+
+    expect(result.current.x).toBe(newPos.x);
+
+    fireEvent.scroll(window, { target: { scrollY: newPos.y } });
+
+    expect(result.current.y).toBe(newPos.y);
+  });
+});
diff --git a/src/utils/hooks/use-scroll-position/use-scroll-position.ts b/src/utils/hooks/use-scroll-position/use-scroll-position.ts
new file mode 100644
index 0000000..e20fda5
--- /dev/null
+++ b/src/utils/hooks/use-scroll-position/use-scroll-position.ts
@@ -0,0 +1,31 @@
+import { useCallback, useEffect, useState } from 'react';
+
+export type ScrollPosition = {
+  x: number;
+  y: number;
+};
+
+const defaultPosition: ScrollPosition = { x: 0, y: 0 };
+
+/**
+ * React hook to retrieve the current scroll position based on window.
+ *
+ * @returns {ScrollPosition} The scroll position.
+ */
+export const useScrollPosition = (): ScrollPosition => {
+  const [pos, setPos] = useState(defaultPosition);
+
+  const updatePos = useCallback(() => {
+    setPos({ x: window.scrollX, y: window.scrollY });
+  }, []);
+
+  useEffect(() => {
+    if (typeof window === 'undefined') return undefined;
+
+    window.addEventListener('scroll', updatePos);
+
+    return () => window.removeEventListener('scroll', updatePos);
+  }, [updatePos]);
+
+  return pos;
+};
-- 
cgit v1.2.3