iAPI Router: Add support for new router regions with attachTo
#70421
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
DAreRodz
added
[Type] Feature
|
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. |
|
Size Change: +150 B (+0.01%) Total Size: 1.86 MB
ℹ️ View Unchanged
|
10 tasks
luisherranz
requested changes
Jun 16, 2025
There was a problem hiding this comment.
Could you add an explanation to the documentation of the README.md file? I would also clarify what happens in each case:
- the region exists on both pages
- the region exists on the current page but not on the new page
- the region exists on the new page but not on the current page.
|
In your video, there is a moment (second 5) when the image disappears completely. I don't know if it's related, but that shouldn't happen. 
|
I believe it is not related to this pull request. This is something I noticed as well and it happens in The problem is that we are hiding the original image with this directive, so if the lightbox overlay is not loaded yet, there is a moment when there is no image at all. Context for this change can be found in this pull request. I am not sure what is the best approach there, to be honest. |
Then there's no problem, thank you! |
Base automatically changed from
feature/iapi-new-client-side-navigation
to
trunk
June 18, 2025 07:20
DAreRodz
force-pushed
the
backport/iapi-router-regions-attach-to
branch
from
8449c0e to
135a016
Compare
README.md updated, @luisherranz. |
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?
Warning
This PR has been created on top of #70353. Wait for that PR to be merged before merging this one.
Renders missing router regions from newly visited pages when they have an
attachToproperty defined.The
attachToproperty should be a valid CSS selector, pointing to the parent element where the new router region should be rendered.E.g., this region would be rendered in
<body>if it appears in a visited page, even when it wasn't initially rendered.Why?
To support regions that don't exist in the previous page, like for example the overlay of the image lightbox.
How?
Inside
regionsToVdom(), when a new page is processed, aregionsToAttachobject is created, mapping the ID of each router region withattachToto the CSS selector of the target parent element. The vDOM tree of these regions is still stored inregionsas usual.Later, inside
renderRegions(), when that page is rendered, all regions in the current HTML are updated with the new content. Regions withattachTocould already be present in the current HTML, and these are updated as previously. Only new regions withattachToare handled differently, creating a new root fragment for each of them in the corresponding target defined byattachTo.If any of these regions disappear on subsequent pages, they are unmounted as expected.
Testing Instructions
There are e2e tests for this feature.
Also, this feature can be tested manually. For that, you have to ensure the changes in #70416 are included, and follow these steps:
/?query-1-page=999). You should see something like "Sorry, but nothing was found. Please try a search with different keywords".