Make onPatternCategorySelection private #62130
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
ntsekouras
added
the
[Type] Code Quality
|
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. |
|
Size Change: +66 B (0%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
|
@ntsekouras, the difference is only the name change, correct? |
The name change and making the two components private. |
Mamaduka
approved these changes
May 30, 2024
|
As an alternative to Symbols, you could create a uuid and use that as the prop name, and lock that. |
draganescu
reviewed
May 30, 2024
There was a problem hiding this comment.
This is great @ntsekouras - thank you for stepping in as time was of essence considering the approaching beta WP. Left some questions mostly from the experience in my previous PR.
| @@ -341,4 +341,16 @@ function InserterMenu( | |||
| ); | |||
| } | |||
|
|
|||
| export default forwardRef( InserterMenu ); | |||
| export const PrivateInserterMenu = forwardRef( InserterMenu ); | |||
There was a problem hiding this comment.
As far as I've seen the inserter menu component is:
- used exclusively in the block editor package
- used exclusively in the inserter component in the block editor package
- not specifically exported anywhere
What do we need the private component for?
There was a problem hiding this comment.
I thought about it too, and I think it would be fine to not create a private one. Sometimes though we can decide to make some existing components public (recent example here). With that in mind, it would be clear that some props are meant to remain private..
| @@ -7,7 +7,7 @@ import { forwardRef } from '@wordpress/element'; | |||
| /** | |||
| * Internal dependencies | |||
| */ | |||
| import InserterMenu from './menu'; | |||
| import { PrivateInserterMenu } from './menu'; | |||
There was a problem hiding this comment.
I wonder did you try to lock this? If you locked it and then used lock/unlock internally would it work for you? I may have stumbled on some lock / unlock bug in here but I am not sure if it's not some typo on my part.
There was a problem hiding this comment.
I think it works, but there is no need to unlock if used in the same package.
| return ( | ||
| <PrivateInserterLibrary | ||
| { ...props } | ||
| onPatternCategorySelection={ undefined } |
There was a problem hiding this comment.
this is reset to undefined here but to const NOOP in the private inserter menu, which makes the optional chaining maybe not needed.
One more reason to remove the private inserter menu component.
There was a problem hiding this comment.
Probably yes. I was just being defensive there.
draganescu
reviewed
May 30, 2024
| @@ -3,8 +3,8 @@ | |||
| */ | |||
| import { useDispatch, useSelect } from '@wordpress/data'; | |||
| import { | |||
| __experimentalLibrary as Library, | |||
There was a problem hiding this comment.
We kept the export right? So we export an __experimentalLibrary which is less public than the locked one :) Should we stabilise the experimental export?
There was a problem hiding this comment.
Yeah, we could stabilize it and add a deprecation warning.
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jun 4, 2024
Co-authored-by: ntsekouras <[email protected]> Co-authored-by: Mamaduka <[email protected]> Co-authored-by: ellatrix <[email protected]>
patil-vipul
pushed a commit
to patil-vipul/gutenberg
that referenced
this pull request
Jun 17, 2024
Co-authored-by: ntsekouras <[email protected]> Co-authored-by: Mamaduka <[email protected]> Co-authored-by: ellatrix <[email protected]>
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?
Follow up of: #60004 (comment)
Alternative of: #62110
This PR makes the newly added
__experimentalOnPatternCategorySelectionprop private and renames it toonPatternCategorySelectionWhy?
We shouldn't add experimental features/props with just a prefix, because it will end up a public API in WP.
Testing Instructions