Merge remote-tracking branch 'origin/master' into URH-106

Author: bicochan

docs/pages/docs/hooks/_meta.json

@@ -16,6 +16,7 @@
   "usePrefersColorScheme": "usePrefersColorScheme",
   "usePreventCopy": "usePreventCopy",
   "useScrollLock": "useScrollLock",
+  "useScrollY": "useScrollY",
   "useSound": "useSound",
   "useTimer": "useTimer",
   "useToggle": "useToggle",

docs/pages/docs/hooks/useScrollY.mdx

@@ -0,0 +1,37 @@
+# useScrollY
+
+## Introduce
+
+현재 페이지의 스크롤 위치를 저장하고 이동하는 함수를 반환하는 훅입니다.
+
+```ts
+interface UseScrollYReturns {
+  moveTrigger: () => void;
+}
+
+const useScrollY = (): UseScrollYReturns
+```
+
+### Returns
+
+- `moveTrigger`: 저장된 스크롤 위치로 이동하는 함수
+
+## Examples
+
+```tsx copy filename="TestComponent.tsx"
+import { useScrollY } from '@frontend-opensource/use-react-hooks';
+
+function TestComponent() {
+  const { moveTrigger } = useScrollY();
+
+  useEffect(() => {
+    moveTrigger();
+  }, []);
+
+  return (
+    <div>
+      <h1>USE-REACT-HOOKS</h1>
+    </div>
+  );
+}
+```

package.json

@@ -12,7 +12,7 @@
     "build": "rm -rf node_modules/.tmp && tsc -b --verbose",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview",
-    "prepare": "husky",
+    "prepare": "if [ -d .git ] && command -v husky >/dev/null 2>&1; then husky install; else echo 'Skipping husky install'; fi",
     "lint-staged": "lint-staged",
     "test": "jest",
     "coverage": "jest --coverage"

src/hooks/useScrollY/useScrollY.ts

@@ -3,6 +3,12 @@ import { debounce } from '@/utils';
 import { useLocalStorage } from '@/hooks/useLocalStorage';
 import { Fn } from './type';
 
+/**
+ * 현재 페이지의 스크롤 위치를 저장하고 이동하는 함수를 반환하는 훅
+ *
+ * @returns
+ * - `moveTrigger`: 저장된 스크롤 위치로 이동하는 함수
+ */
 const useScrollY = (): { moveTrigger: Fn } => {
   const isClient = typeof window !== 'undefined';