htmx/www/content/headers/hx-push-url.md
MichaelWest22 6ce6a1a77b
Documentation 3xx redirects can't send headers (#2904)
* 3xx redirects can't send headers

* fix response-headers links
2024-09-15 09:29:39 +02:00

20 lines
865 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

+++
title = "HX-Push-Url Response Header"
+++
The `HX-Push-Url` header allows you to push a URL into the browser [location history](https://developer.mozilla.org/en-US/docs/Web/API/History_API).
This creates a new history entry, allowing navigation with the browsers back and forward buttons.
This is similar to the [`hx-push-url` attribute](@/attributes/hx-push-url.md).
If present, this header overrides any behavior defined with attributes.
The possible values for this header are:
1. A URL to be pushed into the location bar.
This may be relative or absolute, as per [`history.pushState()`](https://developer.mozilla.org/en-US/docs/Web/API/History/pushState).
2. `false`, which prevents the browsers history from being updated.
## Notes
Response headers are not processed on 3xx response codes. see [Response Headers](@/docs.md#response-headers)