Add an example of evaluated values passed to hx-headers. #2939
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
Add an example of evaluated values passed to hx-headers.
maciejtrybilo
changed the title
Telroshan
reviewed
Oct 4, 2024
www/content/attributes/hx-headers.md
Outdated
| If you wish for `hx-headers` to *evaluate* the values given, you can prefix the values with `javascript:` or `js:`. | ||
|
|
||
| ```html | ||
| <div hx-get="/example" hx-headers='{"myHeader": "My Value"}'>Get Some HTML, Including A Custom Header in the Request</div> | ||
| <body hx-headers='js:{ "Locale" : new Intl.DateTimeFormat().resolvedOptions().locale }'>...</body> |
There was a problem hiding this comment.
I think to keep the example consistent, we could take inspiration from the hx-vals documentation, which has the following example:
<div hx-get="/example" hx-vals='{"myVal": "My Value"}'>Get Some HTML, Including A Value in the Request</div>
<div hx-get="/example" hx-vals='js:{myVal: calculateValue()}'>Get Some HTML, Including a Dynamic Value from Javascript in the Request</div>I think it's a concise & effective approach, using the same key for the same context element, just changing how the value is retrieved and illustrating how js: works.
Let me know your thoughts on this! Your opinion will have more value than mine on this as I'm likely biased by my htmx experience (as you said, we want the docs to be clear enough for newcomers!)
|
@Telroshan Makes sense, I wasn't aware that the hx-vals page does have an example. And sorry for taking so long! |
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.
Add an example of evaluated values passed to hx-headers.
Description
I haven't been clear from the documentation how to exactly have the javascript in the attribute evaluated as I'm not such a web dev expert. Perhaps it could help someone else if it's more explicit.
The example is more or less taken from my use case. Please feel free to suggest something else!
HTMX works great with Swift, BTW.
Checklist
masterfor website changes,devforsource changes)
approved via an issue
npm run test) and verified that it succeeded