useInnerBlocksProps: Make dropZoneElement private, access via PrivateBlockList #56308
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
andrewserong
added
[Type] Code Quality
andrewserong
requested review from
youknowriad,
apeatling,
ramonjd and
tellthemachines
2 tasks
|
Size Change: +67 B (0%) Total Size: 1.7 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in ba2a932. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6924152507
|
|
Update: I have also opened an alternative PR that takes the simpler approach of stabilising the property instead, over in #56313 — I think that might be the preferable approach as after digging into a prototype in #56312, I believe we'll likely need the prop on |
|
I trust your judgement here, both options work for me. we just should stop using the prefixes. |
|
Thanks for confirming, Riad! I'll close this one out, and merge the stabilisation PR. |
youknowriad
deleted the
update/make-drop-zone-element-private-for-inner-blocks-props
branch
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 to #56070 to make the
dropZoneElementused inuseInnerBlocksPropsprivate for now, as suggested in this comment: #56070 (comment) from @youknowriad.Note
A potential alternative that is simpler and might be a better direction, is to stabilise the property, which is also explored over in #56313 — I'd love to hear if folks prefer the idea of stabilising for now, or making private for now.
Why?
Currently the API for
dropZoneElementis unstable foruseInnerBlocksPropsandBlockListas we're not 100% certain if this should be a public API. It is however stable foruseBlockDropZonewhere it is stable.If the API is to remain unstable, then for now, it would be better to make the API private.
An alternative to this PR would be to stabilise
dropZoneElementinuseInnerBlocksPropsandBlockList— I'm happy to try that if there is consensus that we think we should support exposing it there in the long-term.Also, let me know if anyone can think of a simpler way of making these props private.
How?
useInnerBlocksPropstousePrivateInnerBlocksPropsso that it can usedropZoneElementinternallyuseInnerBlocksPropsback in as an export, and internally overridedropZoneElementto make it privateBlockList'sRootcomponent, useusePrivateInnerBlocksPropsso that we can supportdropZoneElementinternallyPrivateBlockListthat supportsdropZoneElementBlockListoverridedropZoneElementto make it privateTesting Instructions
Mostly ensure that #56070 works as expected and that this PR does not break
useInnerBlocksPropsin any wayuseInnerBlocksPropsworks as on trunk, via testing container blocks such as Columns, Group, Gallery, etc