htmx/www/content/headers/hx-push-url.md
William Jackson efcc6b2211
Add descriptions for /headers/* and /api (#3221)
* Add descriptions for /headers/* and /api

* Add a missing space in a description
2025-03-05 20:58:38 -07:00

22 lines
982 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"
description = """\
Use the HX-Push-Url response header in htmx to push a URL into the browser location history."""
+++
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)