Add setShadowRootVersionHash to force shadowRoot to update in provide… #25332
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
Changed Packages
|
|
Thanks for the contribution! |
alexlorenzi
reviewed
Jun 20, 2024
| @@ -102,11 +103,12 @@ export const TechDocsReaderPageContent = withTechDocsReaderProvider( | |||
| const handleAppend = useCallback( | |||
| (newShadowRoot: ShadowRoot) => { | |||
| setShadowRoot(newShadowRoot); | |||
| incShadowRootVersion(); | |||
There was a problem hiding this comment.
My best guess is that because the shadowRoot variable points to the DOM elements when the underlying DOM changes and the setShadowRoot call compares the old and new values to see if they're different they're the same so no side-effects get triggered... So we use the counter as a proxy to trigger these.
squid-ney
force-pushed
the
shadowdom-provider
branch
from
1107ba2
to
f2db271
Compare
github-actions
bot
added
documentation
squid-ney
force-pushed
the
shadowdom-provider
branch
from
8a1f942
to
077e1d6
Compare
…r when version changes. Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com>
Signed-off-by: Alex Lorenzi <alorenzi@spotify.com> Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com>
Signed-off-by: Alex Lorenzi <alorenzi@spotify.com> Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com>
Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com>
squid-ney
force-pushed
the
shadowdom-provider
branch
from
077e1d6
to
abdf744
Compare
Signed-off-by: Sydney Achinger <sydneynicoleachinger@spotify.com>
PeaWarrior
approved these changes
Jun 20, 2024
|
Thank you for contributing to Backstage! The changes in this pull request will be part of the |
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.
Add setShadowRootVersionHash to force shadowRoot to update in provider when version changes. The setShadowRoot doesn't cause a re-render because a ref is passed to it. This hash is a work around to force the update. This PR builds off the investigation done in this PR that points out the useShadowRoot hooks do not behave as expected.
....
Update: Instead of hash we are going to use a simple counter. The hash may affect performance. We really just need some type of simple state that can force the side-effects that setShadowRoot is not.
Hey, I just made a Pull Request!
✔️ Checklist
Signed-off-byline in the message. (more info)