Docs: Interactivity API - Add documentation for getServerState() and getServerContext()#66104
Conversation
DAreRodz
left a comment
There was a problem hiding this comment.
Great docs, @michalczaplinski, especially the part in the Core Concepts guide. 👏
I've left a couple of questions/suggestions.
...interactivity-api/core-concepts/undestanding-global-state-local-context-and-derived-state.md
Show resolved
Hide resolved
...interactivity-api/core-concepts/undestanding-global-state-local-context-and-derived-state.md
Outdated
Show resolved
Hide resolved
|
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. |
|
Flaky tests detected in 2330492. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11443229130
|
…d `getServerContext()` (WordPress#66104) * Add documentation on `getServerState()` and `getServerContext()` * update heading level * Undelete the "Conclusion" * Fix link to the documentation * update link to router docs * clarify about context * add reference to @wordpress/router Co-authored-by: michalczaplinski <czapla@git.wordpress.org> Co-authored-by: DAreRodz <darerodz@git.wordpress.org>
luisherranz
left a comment
There was a problem hiding this comment.
Sorry for being late to the party 😄
Apart from those two small changes could we add a clarification that, since these are reactive, if the value of a property doesn’t change, the watch callback will not re-trigger? Does that make sense?
|
|
||
| ```php | ||
| <?php | ||
| wp_interactivity_context( 'myPlugin', array( |
There was a problem hiding this comment.
wp_interactivity_context should be wp_interactivity_data_wp_context and be used inside an HTML tag.
|
|
||
| ### When to Use | ||
|
|
||
| Whenever you have interactive blocks that rely on global state that may change due to navigation events, ensuring consistency across different parts of your application. |
There was a problem hiding this comment.
Whenever you have interactive blocks that rely on global state or local context that may change due to navigation events, ensuring consistency across different parts of your application.
|
@luisherranz Thanks for taking a look! I've implemented your comments in #67499 |
|
Thanks, Michal. |
getServerState()andgetServerContext()functions were added to the Interactivity API in #65151This PR adds documentation for both of them. Those functions are going to ship in WP 6.7.
Additionally, the files are now formatter with
prettieras they should be.