Skip to content

allow hx-headers to access event #3462

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
+59 −28
Open

allow hx-headers to access event #3462

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e816f6
allow hx-headers to access event type
scratchmex Oct 8, 2025
1fcf4b1
add jsdoc and fix cap
scratchmex Oct 8, 2025
a2d7abf
fix load trigger to fire events properly
scratchmex Oct 9, 2025
47b5529
add tests for hx-headers event acces and load event
scratchmex Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/htmx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2648,7 +2648,7 @@ var htmx = (function() {
if (!nodeData.loaded) {
nodeData.loaded = true
triggerEvent(elt, 'htmx:trigger')
handler(elt)
handler(elt, makeEvent('load', { elt }))
}
}
if (delay > 0) {
Expand Down Expand Up @@ -3687,7 +3687,7 @@ var htmx = (function() {
* @param {string} prompt
* @returns {HtmxHeaderSpecification}
*/
function getHeaders(elt, target, prompt) {
function getHeaders(elt, target, prompt, event) {
/** @type HtmxHeaderSpecification */
const headers = {
'HX-Request': 'true',
Expand All @@ -3696,7 +3696,7 @@ var htmx = (function() {
'HX-Target': getAttributeValue(target, 'id'),
'HX-Current-URL': location.href
}
getValuesForElement(elt, 'hx-headers', false, headers)
getValuesForElement(elt, 'hx-headers', false, headers, event)
if (prompt !== undefined) {
headers['HX-Prompt'] = prompt
}
Expand Down Expand Up @@ -4420,7 +4420,7 @@ var htmx = (function() {
}
}

let headers = getHeaders(elt, target, promptResponse)
let headers = getHeaders(elt, target, promptResponse, event)

if (verb !== 'get' && !usesFormData(elt)) {
headers['Content-Type'] = 'application/x-www-form-urlencoded'
Expand Down
6 changes: 6 additions & 0 deletions www/content/attributes/hx-headers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ If you wish for `hx-headers` to *evaluate* the values given, you can prefix the
<div hx-get="/example" hx-headers='js:{myVal: calculateValue()}'>Get Some HTML, Including a Dynamic Custom Header from Javascript in the Request</div>
```

When using evaluated code you can access the `event` object.

```html
<div hx-get="/example" hx-headers='js:{"hx-trigger-event": event.type}'>Get Some HTML, Including a custom header indicating which event triggered the request</div>
```

## Security Considerations

* By default, the value of `hx-headers` must be valid [JSON](https://developer.mozilla.org/en-US/docs/Glossary/JSON).
Expand Down