Visual diff: trigger DOM_CHANGED event after enable/disable
#465
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
A new event `READTHEDOCS_ROOT_DOM_CHANGED` is triggered when the "Visual diff" is enabled/disabled after the DOM was modified. This allows other addons to subscribe to this event to re-initialize if required. I used this event from links preview to call `setupTooltips` again to re-install tooltips on these links. I migrated links preview to a `LitElement` to be able to make usage of this pattern and follow what we already had. We will be able to do something similar on #157
…diff-dom-changed-event
ericholscher
pushed a commit
that referenced
this pull request
Dec 9, 2024
ericholscher
approved these changes
Dec 9, 2024
| @@ -9,6 +9,8 @@ export const EVENT_READTHEDOCS_FLYOUT_SHOW = "readthedocs-flyout-show"; | |||
| export const EVENT_READTHEDOCS_FLYOUT_HIDE = "readthedocs-flyout-hide"; | |||
| export const EVENT_READTHEDOCS_ADDONS_DATA_READY = | |||
| "readthedocs-addons-data-ready"; | |||
| export const EVENT_READTHEDOCS_ROOT_DOM_CHANGED = | |||
There was a problem hiding this comment.
Should we have a docstring or similar to describe the events here?
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.
A new event
READTHEDOCS_ROOT_DOM_CHANGEDis triggered when the "Visual diff" is enabled/disabled after the DOM was modified.This allows other addons to subscribe to this event to re-initialize if required. I used this event from links preview to call
setupTooltipsagain to re-install tooltips on these links.I migrated links preview to a
LitElementto be able to make usage of this pattern and follow what we already had.We will be able to do something similar on #157
Closes #460