Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve detail.elt event documentation #3007

Merged
merged 2 commits into from
Nov 24, 2024

Conversation

MichaelWest22
Copy link
Contributor

@MichaelWest22 MichaelWest22 commented Nov 8, 2024

Description

Event documentation for detail.elt is incorrect and confusing as the current documentation has this field listed as the element that dispatched the request when 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

  • I have read the contribution guidelines
  • I have targeted this PR against the correct branch (master for website changes, dev for
    source changes)
  • This is either a bugfix, a documentation update, or a new feature that has been explicitly
    approved via an issue
  • I ran the test suite locally (npm run test) and verified that it succeeded

@MichaelWest22 MichaelWest22 changed the title Detail elt doco Improve detail.elt event documentation Nov 8, 2024
@Telroshan Telroshan added documentation Improvements or additions to documentation ready for review Issues that are ready to be considered for merging labels Nov 9, 2024
@alexpetros
Copy link
Collaborator

Hey thanks for taking the time to do this, it's a really huge improvement!

@alexpetros alexpetros merged commit 5373966 into bigskysoftware:dev Nov 24, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready for review Issues that are ready to be considered for merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants