Skip to content
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

feat: create useViewportSize hook #933

Merged
merged 2 commits into from
Aug 24, 2023
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import {act, fireEvent, renderHook} from '@testing-library/react';

import {useViewportSize} from '..';

test('Check useViewportSize correct work', () => {
const view = renderHook(() => useViewportSize());

act(() => {
window.innerHeight = 500;
window.innerWidth = 500;
});

fireEvent(window, new Event('resize'));

expect(view.result.current).toEqual({height: 500, width: 500});

act(() => {
window.innerHeight = 1200;
window.innerWidth = 1200;
});

fireEvent(window, new Event('resize'));

expect(view.result.current).toEqual({height: 1200, width: 1200});
});
2 changes: 2 additions & 0 deletions src/components/utils/useViewportSize/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export {useViewportSize} from './useViewportSize';
export type {ViewportSize} from './useViewportSize';
38 changes: 38 additions & 0 deletions src/components/utils/useViewportSize/useViewportSize.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import React from 'react';

export interface ViewportSize {
width?: number;
height?: number;
}

const getViewportSize = (): ViewportSize => ({
width: window?.visualViewport?.width ?? window?.innerWidth ?? undefined,
height: window?.visualViewport?.height ?? window?.innerHeight ?? undefined,
});

/**
* A hook to get the size of the viewport when resizing
*
* @return - {width, height}
*/
export const useViewportSize = (): ViewportSize => {
const [size, setSize] = React.useState<ViewportSize>(getViewportSize());

React.useEffect(() => {
const onResize = () => {
let newSize = getViewportSize();
if (newSize.width === size?.width && newSize.height === size?.height) {
newSize = size;
}
setSize(newSize);
};

(window.visualViewport ?? window).addEventListener('resize', onResize);

return () => {
(window.visualViewport ?? window).removeEventListener('resize', onResize);
};
}, [size]);

return size;
};
Loading