-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
Block Editor: Add documentation for SpacingSizesControl component #68581
Block Editor: Add documentation for SpacingSizesControl component #68581
Conversation
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. |
packages/block-editor/src/components/spacing-sizes-control/README.md
Outdated
Show resolved
Hide resolved
packages/block-editor/src/components/spacing-sizes-control/README.md
Outdated
Show resolved
Hide resolved
Hi @stokesman, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the update 🙇. I had a look at prior art around the codebase and have some more suggestions.
packages/block-editor/src/components/spacing-sizes-control/index.js
Outdated
Show resolved
Hide resolved
- Removed unnecessary props and wrappers - Added proper state management with useState hook - Ensured consistent documentation between the component and README - Replaced SpacerBlock with Example component - Added proper imports for SpacingSizesControl and useState - Removed unnecessary View wrapper and optional props - Updated README to match the new implementation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the updates again 🙇.
packages/block-editor/src/components/spacing-sizes-control/README.md
Outdated
Show resolved
Hide resolved
packages/block-editor/src/components/spacing-sizes-control/README.md
Outdated
Show resolved
Hide resolved
packages/block-editor/src/components/spacing-sizes-control/README.md
Outdated
Show resolved
Hide resolved
packages/block-editor/src/components/spacing-sizes-control/index.js
Outdated
Show resolved
Hide resolved
packages/block-editor/src/components/spacing-sizes-control/README.md
Outdated
Show resolved
Hide resolved
- Removed redundant description section in README - Consolidated component description into a single paragraph - Updated import examples to use `__experimentalSpacingSizesControl` alias - Removed screenshot reference - Standardized prop descriptions
Hi @stokesman, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems adequate to me. Thank you @Infinite-Null!
Related to: #22891
Closes: #52070
What?
Adds documentation for the SpacingSizesControl component by:
Why?
The SpacingSizesControl component currently lacks documentation, making it difficult for developers to understand and implement the component correctly:
The documentation follows established patterns from other components while providing specific details relevant to SpacingSizesControl, making it easier for developers to use this component effectively in their blocks.