update event doco and rename to historyElt to be consistent

Author: MichaelWest22

src/htmx.js

@@ -3248,7 +3248,7 @@ var htmx = (function() {
   function loadHistoryFromServer(path) {
     const request = new XMLHttpRequest()
     const swapSpec = { swapStyle: 'innerHTML', swapDelay: 0, settleDelay: 0 }
-    const details = { path, xhr: request, historyElement: getHistoryElement(), swapSpec }
+    const details = { path, xhr: request, historyElt: getHistoryElement(), swapSpec }
     request.open('GET', path, true)
     request.setRequestHeader('HX-Request', 'true')
     request.setRequestHeader('HX-History-Restore-Request', 'true')
@@ -3257,8 +3257,8 @@ var htmx = (function() {
       if (this.status >= 200 && this.status < 400) {
         details.response = this.response
         triggerEvent(getDocument().body, 'htmx:historyCacheMissLoad', details)
-        swap(details.historyElement, details.response, swapSpec, {
-          contextElement: details.historyElement,
+        swap(details.historyElt, details.response, swapSpec, {
+          contextElement: details.historyElt,
           historyRequest: true
         })
         currentPathForHistory = details.path
@@ -3281,10 +3281,10 @@ var htmx = (function() {
     const cached = getCachedHistory(path)
     if (cached) {
       const swapSpec = { swapStyle: 'innerHTML', swapDelay: 0, settleDelay: 0, scroll: cached.scroll }
-      const details = { path, item: cached, historyElement: getHistoryElement(), swapSpec }
+      const details = { path, item: cached, historyElt: getHistoryElement(), swapSpec }
       if (triggerEvent(getDocument().body, 'htmx:historyCacheHit', details)) {
-        swap(details.historyElement, cached.content, swapSpec, {
-          contextElement: details.historyElement,
+        swap(details.historyElt, cached.content, swapSpec, {
+          contextElement: details.historyElt,
           title: cached.title
         })
         currentPathForHistory = details.path

test/core/events.js

@@ -772,7 +772,7 @@ describe('Core htmx Events', function() {
   it('htmx:historyCacheMissLoad event can update history swap', function() {
     localStorage.removeItem(HTMX_HISTORY_CACHE_NAME)
     var handler = htmx.on('htmx:historyCacheMissLoad', function(evt) {
-      evt.detail.historyElement = byId('hist-re-target')
+      evt.detail.historyElt = byId('hist-re-target')
       evt.detail.swapSpec.swapStyle = 'outerHTML'
       evt.detail.response = '<div id="hist-re-target">Updated<div>'
       evt.detail.path = '/test3'
@@ -855,7 +855,7 @@ describe('Core htmx Events', function() {
   it('htmx:historyCacheHit event can update history swap', function() {
     localStorage.removeItem(HTMX_HISTORY_CACHE_NAME)
     var handler = htmx.on('htmx:historyCacheHit', function(evt) {
-      evt.detail.historyElement = byId('hist-re-target')
+      evt.detail.historyElt = byId('hist-re-target')
       evt.detail.swapSpec.swapStyle = 'outerHTML'
       evt.detail.item.content = '<div id="hist-re-target">Updated<div>'
       evt.detail.path = '/test3'

www/content/events.md

@@ -262,7 +262,7 @@ You can also override the details of the history restoration request in this eve
 
 ##### Details
 
-* `detail.historyElement` - the history element or body that will get replaced
+* `detail.historyElt` - the history element or body that will get replaced
 * `detail.item.content` - the content of the cache that will be swapped in
 * `detail.item.title` - the page title to update from the cache
 * `detail.path` - the path and query of the page being restored
@@ -277,7 +277,7 @@ You can also modify the xhr request or other details before it makes the the req
 
 ##### Details
 
-* `detail.historyElement` - the history element or body that will get replaced
+* `detail.historyElt` - the history element or body that will get replaced
 * `detail.xhr` - the `XMLHttpRequest` that will retrieve the remote content for restoration
 * `detail.path` - the path and query of the page being restored
 * `detial.swapSpec` - the swapSpec to be used containing the defatul swapStyle='innerHTML'
@@ -301,7 +301,7 @@ You can modify the details before it makes the swap to restore the history
 
 ##### Details
 
-* `detail.historyElement` - the history element or body that will get replaced
+* `detail.historyElt` - the history element or body that will get replaced
 * `detail.xhr` - the `XMLHttpRequest`
 * `detail.path` - the path and query of the page being restored
 * `detail.response` - the response text that will be swapped in
@@ -320,12 +320,14 @@ This event is triggered when htmx handles a history restoration action
 
 ### Event - `htmx:beforeHistorySave` {#htmx:beforeHistorySave}
 
-This event is triggered before the content is saved in the history api.
+This event is triggered before the content is saved in the history cache.
+
+You can modify the contents of the historyElt to remove 3rd party javascript changes so a clean copy of the content can be backed up to the history cache
 
 ##### Details
 
-* `detail.path` - the path and query of the page being restored
-* `detail.historyElt` - the history element being restored into
+* `detail.path` - the path and query of the page being saved
+* `detail.historyElt` - the history element about to be saved
 
 ##### Details