Skip to content

[URH-12] useWindowSize 신규 #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Jul 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions src/hooks/useWindowSize.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import { useEffect, useState } from 'react';
import { PositiveInteger } from '../types/number';

interface WindowSize {
width: number | null;
height: number | null;
}

/**
* useWindowSize : 브라우저의 너비와 높이를 제공하는 훅
* @param {number} [delayTime=200] 지연 시간(ms). 리사이즈 이벤트 딜레이 설정. Default=200
* @returns {{ width: number, height: number }} 브라우저의 너비와 높이를 담은 객체
* @description
* 브라우저 창의 사이즈가 변경될 때마다 해당 창의 너비와 높이를 업데이트합니다.
* UI의 세밀한 조작 등 동적인 변화에 유용합니다.
*/

const useWindowSize = <T extends number>(
delayTime: PositiveInteger<T> = 200 as PositiveInteger<T>
): WindowSize => {
const isClient = typeof window === 'object';

const [windowSize, setWindowSize] = useState<WindowSize>({
width: isClient ? window.innerWidth : null,
height: isClient ? window.innerHeight : null,
});

useEffect(() => {
if (!isClient) return;

let timeoutId: NodeJS.Timeout | null = null;

const updateWindowSize = () => {
setWindowSize({
width: window.innerWidth,
height: window.innerHeight,
});
};

const handleWindowResize = () => {
if (timeoutId) clearTimeout(timeoutId);

if (delayTime > 0) {
timeoutId = setTimeout(updateWindowSize, delayTime);
} else if (delayTime === 0) {
updateWindowSize();
}
};

window.addEventListener('resize', handleWindowResize);
return () => {
window.removeEventListener('resize', handleWindowResize);
if (timeoutId) clearTimeout(timeoutId);
};
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);

return windowSize;
};

export default useWindowSize;