compose: Add types to useResizeObserver and type checking to useIsomorphicLayoutEffect
#32111
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sarayourfriend
added
[Type] Code Quality
|
Size Change: 0 B Total Size: 1.86 MB ℹ️ View Unchanged
|
ciampo
reviewed
May 24, 2021
| @@ -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` | |||
There was a problem hiding this comment.
Why is the React Native version a completely different implementation of the web version?
There was a problem hiding this comment.
I'm asuming react-resize-aware doesn't work for react native 🤷♀️ In any case it's outside the scope of this PR. They have the exact same API FWIW.
ciampo
reviewed
May 24, 2021
There was a problem hiding this comment.
This might be a little controversial as I'm actually just relying on the fact that we're re-exporting react-resize-aware and that the types should come from there. This slightly worsens the WP docs but with a link to the upstream docs I think it's for the best.
I think this is definitely a good step forward.
Should we pin a specific version of the react-size-aware package when linking out to its repo / docs?
sarayourfriend
force-pushed
the
add/types-compose-misc
branch
from
63f1a90 to
bc68297
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds types and type checking to
useResizeObserveranduseIsomorphicLayoutEffect.This might be a little controversial as I'm actually just relying on the fact that we're re-exporting
react-resize-awareand that the types should come from there. This slightly worsens the WP docs but with a link to the upstream docs I think it's for the best.How has this been tested?
Type checks pass. No runtime changes.
Types of changes
New feature.
Checklist:
*.native.jsfiles for terms that need renaming or removal).