Track DOM content loaded for ready() function#1688
Merged
Conversation
xhaggi
reviewed
Aug 10, 2023
cc7e9a9 to
bc75192
Compare
bc75192 to
cf9337c
Compare
Contributor
|
Looks good 👍 |
This was referenced Aug 11, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Updated version of #1659 and #1681 based on conversation with @xhaggi.
Basically there's a gap between the
DOMContentLoadedevent firing and the document readystate updating tocomplete. If you look at some stackoverflow answers you can see that people think these two things should be the same, but they are not.Fortunately, it's not hard for us to track with a closure.
DOMContentLoadedwill only run after all the deferred scripts have been executed, so as long as we listen for it on the initial execution ofhtmx, we should be safe. For good measure, I ORed it withgetDocument().readystate === 'complete', in case someone is doing something insane like hotswapping the htmx script tag into the DOM based on some user action (don't do that).Sort of an "ugh, JavaScript" moment but I'd argue it's really more of an "ugh, DOM APIs" moment.
DOMContentLoaded event: https://developer.mozilla.org/en-US/docs/Web/API/Document/DOMContentLoaded_event
Document readystate: https://developer.mozilla.org/en-US/docs/Web/API/Document/readyState