BaseControl: Update Prop docs#70064
BaseControl: Update Prop docs#70064Mayank-Tripathi32 wants to merge 3 commits intoWordPress:trunkfrom
Conversation
a783637 to
a31a15d
Compare
|
Hi @Mayank-Tripathi32, I looked into this and ran the build script on trunk everything seems to work well, Then I checkout into your PR and ran the build command it failed and failed specifically on type build then I remove your type change back to I think the Build is failing because of the type change in your PR. |
|
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. |
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
Fixes #70063
What?
Closes #70063
This PR fixes the documentation for the BaseControl component to clarify that it doesn't support the
asprop, while its VisualLabel subcomponent does.Why?
The prop docs for the BaseControl component incorrectly suggested that it takes an
asprop due to the prop type definition. However, in reality, theasprop is not passed down to the internal wrapper component. This PR updates the documentation to correctly reflect the component's behavior.How?
BaseControlcomponent and regenerated the README.mdTesting Instructions
packages/components/src/base-control/index.tsxaspropTesting Instructions for Keyboard
Not applicable as this is a documentation-only change.
Screenshots or screencast
Not applicable as this is a documentation-only change.