-
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
Fix example of useBlockProps hook #64363
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. |
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 PR!
The API documentation is auto-generated from JSDoc, so you need to fix it here:
gutenberg/packages/block-editor/src/components/block-list/use-block-props/index.js
Lines 52 to 58 in 720522f
* const blockProps = useBlockProps( | |
* className: 'my-custom-class', | |
* style: { | |
* color: '#222222', | |
* backgroundColor: '#eeeeee' | |
* } | |
* ) |
After making changes, run npm run docs:build
. Then commit and push those changes.
@t-hamano Thanks for the guidance! Updated. |
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.
LGTM 👍
* Fix example of useBlockProps hook * chore: tweaks * chore: updates Co-authored-by: meteorlxy <meteorlxy@git.wordpress.org> Co-authored-by: t-hamano <wildworks@git.wordpress.org>
What?
Fix example of
useBlockProps
hook in the readme fileWhy?
The example code is wrong. The wrapper
{ }
of the object is missing.How?
Wrap the object with
{ }
correctlyTesting Instructions
N/A
Testing Instructions for Keyboard
N/A
Screenshots or screencast
N/A