Docs: example for getSelectedBlock #66108
Merged
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
troychaplin
requested review from
ellatrix,
ajitbohra,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
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. |
troychaplin
added
the
[Type] Developer Documentation
|
Size Change: 0 B Total Size: 1.77 MB ℹ️ View Unchanged
|
|
Flaky tests detected in 2d840af. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11334592229
|
troychaplin
changed the title
ryanwelcher
requested changes
Oct 15, 2024
| } | ||
| }; | ||
|
|
||
| wp.data.subscribe( () => { |
There was a problem hiding this comment.
I'm not sure we need this part it doesn't add much to the example and might be taken as being needed to use it.
There was a problem hiding this comment.
Without a listener the function wouldn't log anything to the console, the subscribe would be needed here.
There was a problem hiding this comment.
Right, but this could also be assigned to a button onClick or run in a useEffect for example.
Looking at some other examples, we don't always show how the implementation should be used - just how to implement the item in question.
That being said, this is a strong opinion loosely held so I'll leave it up to you :) If you decide to keep it can we change the subscribe syntax to use imports instead of accessing the global?
Great work and keep them coming!
There was a problem hiding this comment.
If we remove subscribe is there a preferred way to add a note relating to a couple of use cases. I never thought about using it in an onClick, might be good to show both options in the docs.
Thoughts?
There was a problem hiding this comment.
You could add it commented out similar to how it's shown here
There was a problem hiding this comment.
You could add it commented out similar to how it's shown here
That the correct link? Seems unrelated
There was a problem hiding this comment.
🤦 this is the correct link https://developer.wordpress.org/block-editor/reference-guides/packages/packages-core-data/#useentityrecord
There was a problem hiding this comment.
Thanks, added a couple of examples of how the function can be used
ryanwelcher
approved these changes
Oct 16, 2024
I know you approved but I made a followup change so if you could just take a quick peak before I merge that’d be great |
cbravobernal
changed the title
karthick-murugan
pushed a commit
to karthick-murugan/gutenberg
that referenced
this pull request
Nov 13, 2024
* add: example for getSelectedBlock * change: build docs
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?
Adding an example for getSelectedBlock from the block-editor package
Why?
Because examples are needed as per #42125
How?
Function had no example before