Merge pull request #29094 from software-mansion-labs/ts-migration-use…

…-window-dimensions

[No QA][TS migration] Migrate useWindowDimensions

src/hooks/useWindowDimensions/index.native.js → src/hooks/useWindowDimensions/index.native.ts

@@ -1,17 +1,18 @@
 // eslint-disable-next-line no-restricted-imports
 import {useWindowDimensions} from 'react-native';
 import variables from '../../styles/variables';
+import WindowDimensions from './types';
 
 /**
  * A convenience wrapper around React Native's useWindowDimensions hook that also provides booleans for our breakpoints.
- * @returns {Object}
  */
-export default function () {
+export default function (): WindowDimensions {
     const {width: windowWidth, height: windowHeight} = useWindowDimensions();
     const isExtraSmallScreenHeight = windowHeight <= variables.extraSmallMobileResponsiveHeightBreakpoint;
     const isSmallScreenWidth = true;
     const isMediumScreenWidth = false;
     const isLargeScreenWidth = false;
+
     return {
         windowWidth,
         windowHeight,

src/hooks/useWindowDimensions/index.js → src/hooks/useWindowDimensions/index.ts

@@ -1,19 +1,20 @@
 // eslint-disable-next-line no-restricted-imports
 import {Dimensions, useWindowDimensions} from 'react-native';
 import variables from '../../styles/variables';
+import WindowDimensions from './types';
 
 /**
  * A convenience wrapper around React Native's useWindowDimensions hook that also provides booleans for our breakpoints.
- * @returns {Object}
  */
-export default function () {
+export default function (): WindowDimensions {
     const {width: windowWidth, height: windowHeight} = useWindowDimensions();
     // When the soft keyboard opens on mWeb, the window height changes. Use static screen height instead to get real screenHeight.
     const screenHeight = Dimensions.get('screen').height;
     const isExtraSmallScreenHeight = screenHeight <= variables.extraSmallMobileResponsiveHeightBreakpoint;
     const isSmallScreenWidth = windowWidth <= variables.mobileResponsiveWidthBreakpoint;
     const isMediumScreenWidth = windowWidth > variables.mobileResponsiveWidthBreakpoint && windowWidth <= variables.tabletResponsiveWidthBreakpoint;
     const isLargeScreenWidth = windowWidth > variables.tabletResponsiveWidthBreakpoint;
+
     return {
         windowWidth,
         windowHeight,

src/hooks/useWindowDimensions/types.ts

@@ -0,0 +1,10 @@
+type WindowDimensions = {
+    windowWidth: number;
+    windowHeight: number;
+    isExtraSmallScreenHeight: boolean;
+    isSmallScreenWidth: boolean;
+    isMediumScreenWidth: boolean;
+    isLargeScreenWidth: boolean;
+};
+
+export default WindowDimensions;