-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
add: usage examples in core editor docs #63768
add: usage examples in core editor docs #63768
Conversation
…tribute, getCurrentPostType
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. |
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.
Try running npm run lint:js:fix
to see if that updates the examples to match the standards.
Get the current post type | ||
|
||
```js | ||
const currentPostType = wp.data.select('core/editor').getCurrentPostType() |
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.
const currentPostType = wp.data.select('core/editor').getCurrentPostType() | |
const currentPostType = wp.data.select( 'core/editor' ).getCurrentPostType() |
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.
Looks like the whitespace is different than WP coding standards and that's what is failing .
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.
I got my formatting conflict fix up in vscode, and it appears to be using WP standards (it's been a min, been uring psr for a long time) but it's still failing. If I try and run npm run lint:js:fix
I get a warning that stops the process, which also happens to me when I update trunk. This might be a new issue? I'll have to check the issues
…oychaplin/gutenberg into docs/add-core-editor-examples
I just took a quick look and there seems to be a lot of whitespace changes that don't look like they should be there. |
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!
🙌 |
What?
Usage examples in documentation for core/editor package for
editPost
,getEditedPostAttribute
andgetCurrentPostType
. Part of #42125Why?
Because examples are important and help devs learn to use the tools
How?
The noted selectors / actions had no examples prior to this PR