Improve detail.elt event documentation #3007
Open
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
Telroshan
added
documentation
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.
Description
Event documentation for detail.elt is incorrect and confusing as the current documentation has this field listed as
the element that dispatched the requestwhen in fact a different element is being passed into the event. The detail.elt is always the element that the event is triggered on in htmx and this has to often be the element in question and not the one that started the request.Corresponding issue:
#3000
Testing
No testing just careful reading of source to check how the events are actually triggered
Checklist
masterfor website changes,devforsource changes)
approved via an issue
npm run test) and verified that it succeeded