compose: Add types to useResizeObserver (#32111)

WordPress · May 25, 2021 · f10179b · f10179b
1 parent 59a3b77
commit f10179b
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 6 deletions.
diff --git a/packages/compose/README.md b/packages/compose/README.md
@@ -406,6 +406,13 @@ _Returns_
 Hook which allows to listen the resize event of any target element when it changes sizes.
 _Note: `useResizeObserver` will report `null` until after first render_
 
+Simply a re-export of `react-resize-aware` so refer to its documentation <https://github.com/FezVrasta/react-resize-aware>
+for more details.
+
+_Related_
+
+-   <https://github.com/FezVrasta/react-resize-aware>
+
 _Usage_
 
 ```js
@@ -421,10 +428,6 @@ const App = () => {
 };
 ```
 
-_Returns_
-
--   `Array`: An array of {Element} `resizeListener` and {?Object} `sizes` with properties `width` and `height`
-
 <a name="useThrottle" href="#useThrottle">#</a> **useThrottle**
 
 Throttles a function with Lodash's `throttle`. A new throttled function will

diff --git a/packages/compose/src/hooks/use-resize-observer/index.js b/packages/compose/src/hooks/use-resize-observer/index.js
@@ -7,7 +7,10 @@ import useResizeAware from 'react-resize-aware';
  * Hook which allows to listen the resize event of any target element when it changes sizes.
  * _Note: `useResizeObserver` will report `null` until after first render_
  *
- * @return {Array} An array of {Element} `resizeListener` and {?Object} `sizes` with properties `width` and `height`
+ * Simply a re-export of `react-resize-aware` so refer to its documentation <https://github.com/FezVrasta/react-resize-aware>
+ * for more details.
+ *
+ * @see https://github.com/FezVrasta/react-resize-aware
  *
  * @example
  *

diff --git a/packages/compose/src/hooks/use-resize-observer/index.native.js b/packages/compose/src/hooks/use-resize-observer/index.native.js
@@ -10,7 +10,7 @@ import { useState, useCallback } from '@wordpress/element';
 /**
  * Hook which allows to listen the resize event of any target element when it changes sizes.
  *
- * @return {Array} An array of {Element} `resizeListener` and {?Object} `sizes` with properties `width` and `height`
+ * @return {[JSX.Element, { width: number, height: number } | null]} An array of {Element} `resizeListener` and {?Object} `sizes` with properties `width` and `height`
  *
  * @example
  *

diff --git a/packages/compose/tsconfig.json b/packages/compose/tsconfig.json
@@ -19,11 +19,13 @@
 		"src/hooks/use-constrained-tabbing/**/*",
 		"src/hooks/use-debounce/**/*",
 		"src/hooks/use-instance-id/**/*",
+		"src/hooks/use-isomorphic-layout-effect/**/*",
 		"src/hooks/use-focus-return/**/*",
 		"src/hooks/use-previous/**/*",
 		"src/hooks/use-media-query/**/*",
 		"src/hooks/use-reduced-motion/**/*",
 		"src/hooks/use-merge-refs/**/*",
+		"src/hooks/use-resize-observer/**/*",
 		"src/utils/**/*"
 	]
 }