Docs: Enhance documentation for Interactivity API and iAPI Router #73766
Conversation
This file contains hidden or 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
- Clarified the behavior of `supports.interactivity` in block supports documentation. - Improved formatting and added descriptions for methods in the interactivity API reference, including `getElement()`, which now details its return structure and usage. - Updated the explanation of how server context and state merging works during navigation in the interactivity API documentation. - Added a warning note in the interactivity-router README regarding the use of `data-wp-router-region` within nested interactive elements.
juanmaguitar
requested review from
luisherranz
and removed request for
ajitbohra and
fabiankaegy
|
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. |
t-hamano
added
[Type] Developer Documentation
luisherranz
reviewed
Dec 9, 2025
Member
luisherranz
left a comment
luisherranz
left a comment
There was a problem hiding this comment.
LGTM, but I think we should rewrite the attributes part of getElement.
github-actions
bot
added
the
[Package] Interactivity Router
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?
See #70883
Documentation improvements for the Interactivity API and block supports.
Why?
The documentation needed clarification and improvements in several areas:
getServerStateandgetServerContextHow?
This PR makes the following documentation improvements:
Block Supports: Added clarification that setting
supports.interactivitytotrueis equivalent to setting bothclientNavigationandinteractivesub-properties totrueInteractivity API Reference:
Router README: Updated
data-wp-router-regiondocumentation to clarify that it must be used alongsidedata-wp-interactiveand added a warning callout about proper usage with nested elementsTesting Instructions
Since this PR only contains documentation changes, no functional testing is required. Please review the documentation changes for accuracy and clarity.
Testing Instructions for Keyboard
N/A - Documentation changes only
Screenshots or screencast
N/A - Documentation changes only