-
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
[Documentation] Add examples for core/data
package
#42639
base: trunk
Are you sure you want to change the base?
Conversation
canUser canUserEditEntityRecord getCurrentTheme getAutosave getAutosaves getBlockPatterns getBlockPatternCategories
const ExampleComponent = () => { | ||
const { postData, termData } = useSelect( ( select ) => { | ||
return { | ||
postData: select( coreDataStore ).getEntityRecord( |
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.
We should consider marking getEntityRecord
and getEntityRecords
selectors as internal and promote related React hooks useEntityRecord
and useEntityRecords
instead. Those selectors still could be useful outside of React components, though. @adamziel, what do you think?
Maybe there is a way to reference those two concepts in some nice way.
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.
These selectors are used across many @wordpress
packages, unfortunately React hooks won't work in custom store actions.
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.
promote related React hooks useEntityRecord and useEntityRecords instead.
This is a great idea! They're more succinct and easier to think of than useSelect
+ getEntityRecord
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.
Let's make sure useSelect
usage in the examples provides the list of dependencies. In most cases, it should be an empty array []
.
Flaky tests detected in f02334d. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5658275236
|
Size Change: 0 B Total Size: 1.75 MB ℹ️ View Unchanged
|
Would love to see this live in the docs! |
What?
This PR adds examples for the the
core/data
package docs. Part of #42125