summaryrefslogtreecommitdiffstatshomepage
path: root/www/attributes/hx-push-url.md
diff options
context:
space:
mode:
Diffstat (limited to 'www/attributes/hx-push-url.md')
-rw-r--r--www/attributes/hx-push-url.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/www/attributes/hx-push-url.md b/www/attributes/hx-push-url.md
new file mode 100644
index 00000000..674c1a62
--- /dev/null
+++ b/www/attributes/hx-push-url.md
@@ -0,0 +1,26 @@
+---
+layout: layout.njk
+title: </> htmx - hx-push-url
+---
+
+## `hx-push-url`
+
+The `hx-push-url` attribute allows you to "push" a new entry into the browser location bar, which creates
+a new history entry, allowing back-button and general history navigation. The possible values of this
+attribute are `true` and `false`.
+
+Here is an example:
+
+```html
+<div hx-get="/account" hx-push-url="true">
+ Go to My Account
+</div>
+```
+
+This will cause htmx to snapshot the current DOM to `localStorage` and push the URL `/account' into the browser
+location bar.
+
+### Notes
+
+* `hx-push-url` is inherited and can be placed on a parent element
+* see also the `X-HX-Push` response header