fix: widget does not load when navigating on pages with view transition [CW-3249] #9443
Conversation
This file contains 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
scmmishra
changed the title
scmmishra
commented
May 9, 2024
|
@pranavrajs @fayazara PTAL |
pranavrajs
approved these changes
May 15, 2024
|
Quick question - is this intended? @scmmishra CleanShot.2024-05-15.at.11.20.16.mp4 |
Yeah, once the widget remounts, the iframe is forced to render again, nothing we can do about it. There are some implementations that require installing |
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.
When visiting another page in turbo, the
bodyis replaced completely, this makes the navigation more SPA like. However the new body does not contain any of the elements added by a client script. This causes the SDK to fail.This PR fixes this by restoring all the elements when rendering the new body. The alternative is re-running the script, however our SDK needs more changes to support resuming, besides it causes the widget to disappear and come back, making it the inferior choice in terms of UX
Something similar happens with Astro with view transitions, this PR fixes that too
The fix
restoreWidgetInDOMmethod toDOMHelpersthis does the work of replacing the elements as required.turbo:before-renderandastro:before-swapThings to note
While not necessary, we need to add
data-turbo-eval="false"to the widget embed script, otherwise the sdk script tag will keep getting added with each navigation. It won't affect the widget.This is not an issue with astro, since it's default behaviour is to no re-run scripts
P.S. We can remove the conditions that check if a site uses
turboorastro