Skip to content

ControlWithError: Add docs about cloned children #71392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
mirka merged 2 commits into from
Sep 4, 2025
Merged

ControlWithError: Add docs about cloned children #71392

mirka merged 2 commits into from
Sep 4, 2025

Conversation

@mirka
Copy link
Member

@mirka mirka commented Aug 28, 2025 •
edited
Loading

What?

Adds documentation to the ControlWithError component explaining how it handles cloned children.

Why?

The ControlWithError component clones its child element to inject enhanced props, but this behavior wasn't documented. This is important because certain behavior will not work if the root-level component of children doesn't handle these injected props (for example if there's a wrapper div around the main control that doesn't forward the necessary props — which happened in #71350 (comment)).

@mirka mirka self-assigned this Aug 28, 2025
@mirka mirka added [Type] Developer Documentation Documentation for developers [Package] Components /packages/components labels Aug 28, 2025
@mirka mirka mentioned this pull request Aug 28, 2025
Merged
@mirka mirka marked this pull request as ready for review September 3, 2025 08:31
@mirka mirka requested a review from ajitbohra as a code owner September 3, 2025 08:31
@github-actions
Copy link

github-actions bot commented Sep 3, 2025 •
edited
Loading

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: mirka <[email protected]>
Co-authored-by: tyxla <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@mirka mirka requested a review from a team September 3, 2025 08:31
tyxla
tyxla approved these changes Sep 3, 2025
View reviewed changes
Copy link
Member

@tyxla tyxla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks!

@github-actions
Copy link

github-actions bot commented Sep 3, 2025

Flaky tests detected in 4b6f8f4.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/17307737882
📝 Reported issues:

@mirka mirka merged commit f51da68 into trunk Sep 4, 2025
67 of 68 checks passed
@mirka mirka deleted the control-with-error-docs branch September 4, 2025 07:12
@github-actions github-actions bot added this to the Gutenberg 21.7 milestone Sep 4, 2025
@maxschmeling maxschmeling mentioned this pull request Oct 7, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tyxla tyxla tyxla approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

Assignees

@mirka mirka

Labels

[Package] Components /packages/components [Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 21.7

Development

Successfully merging this pull request may close these issues.

3 participants

@mirka @tyxla