Skip to content

Add HX-Request header usage documentation #3954

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
HarshAwasth-i wants to merge 1 commit into
base: master
Choose a base branch
from
+13 −0
Open

Add HX-Request header usage documentation #3954

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions www/content/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -824,6 +824,19 @@ Other patterns can be adapted similarly to achieve the progressive enhancement n
As you can see, this requires more thought and more work. It also rules some functionality entirely out of bounds.
These tradeoffs must be made by you, the developer, with respect to your projects goals and audience.


The `HX-Request` header is automatically included by htmx requests.
Servers can use this header to determine whether a request was initiated by htmx and decide whether to return a full page or only a partial HTML fragment.

For example:

```javascript
if (request.headers["HX-Request"]) {
// Return HTML fragment for an htmx request
} else {
// Return complete page for a normal request
}

[Accessibility](https://developer.mozilla.org/en-US/docs/Learn/Accessibility/What_is_accessibility) is a concept
closely related to progressive enhancement. Using progressive enhancement techniques such as `hx-boost` will make your
htmx application more accessible to a wide array of users.
Expand Down