htmx/www/content/headers/hx-replace-url.md

+++ title = "HX-Replace-Url Response Header" description = """
Use the HX-Replace-Url response header in htmx to replace the current URL in the browser location history without
creating a new history entry.""" +++

The HX-Replace-Url header allows you to replace the current URL in the browser location history. This does not create a new history entry; in effect, it removes the previous current URL from the browser’s history. This is similar to the hx-replace-url attribute.

If present, this header overrides any behavior defined with attributes.

The possible values for this header are:

1. A URL to replace the current URL in the location bar. This may be relative or absolute, as per history.replaceState(), but must have the same origin as the current URL.
2. false, which prevents the browser’s current URL from being updated.

Notes

Response headers are not processed on 3xx response codes. see Response Headers