useFocusableIframe: Refactor to TypeScript #45428
Merged
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
walbo
added
[Type] Code Quality
|
|
|
Size Change: -4 B (0%) Total Size: 1.28 MB
ℹ️ View Unchanged
|
ciampo
approved these changes
Nov 1, 2022
packages/compose/README.md
Outdated
| @@ -326,7 +326,7 @@ Dispatches a bubbling focus event when the iframe receives focus. Use | |||
|
|
|||
| _Returns_ | |||
|
|
|||
| - `Object`: Ref to pass to the iframe. | |||
| - Ref to pass to the iframe. | |||
There was a problem hiding this comment.
Nit: would it make more sense to swap Object with RefCallback, instead of just removing it?
There was a problem hiding this comment.
Updated. Since the docs are autogenerated I added a return type in 266fdc5
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.
What?
Refactor
useFocusableIframeto TypeScript.Why?
The return type was wrong and by refactoring it to TypeScript we can rely on the return type of the function istead of JSDocs.
How
Testing Instructions
Run
npm run devand make sure no TypeScript errors occurs.