Update misc types and revert WPCompleter export from components #67599
+14
−22
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
… update types to Object for now. Use ReactElement instead of ReactNode
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
ramonjd
commented
Dec 4, 2024
| @@ -10,12 +10,10 @@ import { decodeEntities } from '@wordpress/html-entities'; | |||
|
|
|||
| const SHOWN_SUGGESTIONS = 10; | |||
|
|
|||
| /** @typedef {import('@wordpress/components').WPCompleter} WPCompleter */ | |||
There was a problem hiding this comment.
Removing this as WPCompleter was never exported from the components package until #67410, where it was advised that it shouldn't be exported.
| /** | ||
| * Creates a suggestion list for links to posts or pages. | ||
| * | ||
| * @return {WPCompleter} A links completer. | ||
| * @return {Object} A links completer. |
There was a problem hiding this comment.
Just to have something there. This PR is only meant to avoid type compilation errors for now.
|
@Mamaduka that was the fastest ✅ in Github history 😆 Thank you!!! |
|
Size Change: 0 B Total Size: 1.83 MB ℹ️ View Unchanged
|
ramonjd
deleted the
update/remove-wpcompleter-export-and-update-misc-jsdocs
branch
michalczaplinski
pushed a commit
that referenced
this pull request
Dec 5, 2024
Co-authored-by: ramonjd <[email protected]> Co-authored-by: Mamaduka <[email protected]> Co-authored-by: ciampo <[email protected]>
|
Thank you, Ramon! To be clear, my suggestion was to revert the initial change mostly because we don't want to release new APIs if we're not 100% sure about needing them (since once they're released, it's hard to take them back)>. A short-term solution for now could be to "duplicate" the type in JSDoc (rather than using Object). And if we actually need that type def, we can consider our options without being rushed by an upcoming plugin/core release :) |
|
Thanks for closing the loop here @ciampo
I was just sweeping the street with these type changes, to unblock other work but I'll do a quick JSDoc follow up with this suggestion. 👍🏻 |
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?
Implements feedback from #67410:
Objectfor now.Testing Instructions for Keyboard
Build should pass as expected