@modern-kit/react/dist/hooks/useWindowSize/index.d.ts

modern-kit/react

interface WindowSize {
    width: number | null;
    height: number | null;
}
interface useWindowSizeProps {
    debounceWait?: number;
}
/**
 * @description 현재 브라우저 창의 너비와 높이 정보를 추적하고, 반환하는 커스텀 훅입니다.
 *
 * 또한, 불 필요한 호출을 방지하기위한 `debounce` 기능을 제공합니다.
 *
 * @param {useWindowSizeProps} props - 선택적인 설정 객체입니다.
 * - `debounceWait`: 해당 값이 있으면 디바운싱이 적용되며, 이벤트를 디바운싱 대기 시간(ms)입니다.
 *
 * @returns {WindowSize} 현재 브라우저 창의 `width`와 `height`를 포함한 객체를 반환합니다.
 *
 * @example
 * const { width, height } = useWindowSize();
 *
 * @example
 * const { width, height } = useWindowSize({ debounceWait: 300 });
 */
declare function useWindowSize({ debounceWait, }?: useWindowSizeProps): WindowSize;

export { useWindowSize };