23.9 kBMarkdownView Raw
1# Changelog
3## [1.9.2] - 2023-04-28
5* Fixed bug w/ `hx-on` not properly de-initializing
7## [1.9.1] - 2023-04-27
9* Fixed a bug with the new naked triggers that prevented boosted elements with explicit `hx-trigger`'s from functioning
10 properly
11* Added code to play well with other libraries that also use the `window.onpopstate` Daily reminder: <https://htmx.org/img/memes/javascripthistory.png>
13## [1.9.0] - 2023-04-11
15* Support for generalized inline event handling via the new [`hx-on`](/attributes/hx-on) attribute, which addresses
16 the shortcoming of limited [`onevent` properties](https://developer.mozilla.org/en-US/docs/Web/Events/Event_handlers#using_onevent_properties) attributes in HTML.
17* Support for [view transitions](/docs#view-transitions), based on the experimental [View Transitions API](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API)
18 currently available in Chrome 111+ and coming to other browsers soon.
19* Support for "naked" [`hx-trigger`](/attributes/hx-trigger) attributes, where an `hx-trigger` is present on an element
20 that does not have an `hx-get`, etc. defined on it. Instead, it will trigger the new `htmx:triggered` event, which can
21 be responded to via your [preferred scripting solution](/docs#scripting).
22* A memory leak fix by [@croxton](https://github.com/bigskysoftware/htmx/commit/8cd3a480a7388877628ce8b9b8e50cd5df48bb81)
23* The htmx website has been migrated from 11ty to [zola](https://www.getzola.org/) by [@danieljsummers](https://github.com/danieljsummers), cutting
24 way down on the number of "development" javascript dependencies
25* Many other smaller bug fixes
27## [1.8.6] - 2023-03-02
29* ESM support!
30* Sass has been vanquished from the htmx.org website, which should set us up for some good progress going forward
31* Fixed a bug where the `changed` modifier on `keyup` did not work properly if an input was tabbed into
32* Many other smaller bug fixes and doc fixes
34## [1.8.5] - 2023-01-17
36* Support a new optional cache-busting configuration option, `getCacheBusterParam`, to allow browsers to disambiguate
37 between `GET` requests from htmx and from the raw browser
38* Support new `hx-history='false'` attribute, to prevent sensitive data from being stored in the history cache. (Thank you @croxton!)
39* Extensive new event-oriented features are available in the [Web Socket](/extensions/web-sockets/) extension (Thank you @Renerick!)
40* A bug fix for when a form contains multiple empty input values with the same name (Thank you @bluekeyes!)
41* A bug fix around inputs that throw exceptions when calling `setSelectionRange()` (Thank you @gone!)
42* A bug fix to pass through the proper event for the `htmx:configRequest` event
43* A bug fix/improvement for the `preload` extension
44* Many other small bug fixes
46## [1.8.4] - 2022-11-05
48* Fix the _exact same_ regression in `revealed` logic as in 1.8.2
50## [1.8.3] - 2022-11-04
52* A new [`htmx:confirm` event](/events#htmx:confirm) was added that allows for asynchronous confirmation dialogs to
53 be integrated into htmx requests
54* The new [head-support](/extensions/head-support) extension allows for more elaborate head tag merging than standard htmx
55 supports. This functionality may be integrated into htmx 2.0, depending on feedback.
56* The new [multi-swap](/extensions/multi-swap) provides more elaborate swapping of multiple elements on a screen using
57 a custom swap strategy
58* Many doc fixes (thank you to everyone who contributed!)
60## [1.8.2] - 2022-10-12
62* Fix regression in `revealed` logic
64## [1.8.1] - 2022-10-11
66* We now keep a count of outstanding requests for an indicator, so more than one overlapping request can share the same
67 indicator without issues
68* We now track the attribute state of an element and re-initialize it if `htmx.process()` is called on the element and
69 the attributes have changed
70* [Idiomorph](https://github.com/bigskysoftware/idiomorph) is now available for all your morph-swapping needs
71* The `unset` directive now works properly for `hx-vals` and `hx-vars`
72* The title of the page is now properly set on a history cache miss
73* The new [`hx-validate`](https://htmx.org/attributes/hx-validate) attribute will force elements to validate before a request, even if
74 they are not within a form being submitted
75* Many smaller bug and docs fixes
77## [1.8.0] - 2022-7-12
79* **NOTE**: This release involved some changes to touchy code (e.g. history support) so please test thoroughly and let
80 us know if you see any issues
81* Boosted forms now will automatically push URLs into history as with links. The [response URL](https://caniuse.com/mdn-api_xmlhttprequest_responseurl)
82 detection API support is good enough that we feel comfortable making this the default now.
83 * If you do not want this behavior you can add `hx-push-url='false'` to your boosted forms
84* The [`hx-replace-url`](https://htmx.org/attributes/hx-replace-url) attribute was introduced, allowing you to replace
85 the current URL in history (to complement `hx-push-url`)
86* Bug fix - if htmx is included in a page more than once, we do not process elements multiple times
87* Bug fix - When localStorage is not available we do not attempt to save history in it
88* [Bug fix](https://github.com/bigskysoftware/htmx/issues/908) - `hx-boost` respects the `enctype` attribute
89* `m` is now a valid timing modifier (e.g. `hx-trigger="every 2m"`)
90* `next` and `previous` are now valid extended query selector modifiers, e.g. `hx-target="next div"` will target the
91 next div from the current element
92* Bug fix - `hx-boost` will boost anchor tags with a `_self` target
93* The `load` event now properly supports event filters
94* The websocket extension has had many improvements: (A huge thank you to Denis Palashevskii, our newest committer on the project!)
95 * Implement proper `hx-trigger` support
96 * Expose trigger handling API to extensions
97 * Implement safe message sending with sending queue
98 * Fix `ws-send` attributes connecting in new elements
99 * Fix OOB swapping of multiple elements in response
100* The `HX-Location` response header now implements client-side redirects entirely within htmx
101* The `HX-Reswap` response header allows you to change the swap behavior of htmx
102* The new [`hx-select-oob`](https://htmx.org/attributes/hx-select-oob) attribute selects one or more elements from a server response to swap in via an out of band swap
103* The new [`hx-replace-url`](https://htmx.org/attributes/hx-replace-url) attribute can be used to replace the current URL in the location
104 bar (very similar to `hx-push-url` but no new history entry is created). The corresponding `HX-Replace-Url` response header can be used as well.
105* htmx now properly handles anchors in both boosted links, as well as in `hx-get`, etc. attributes
107## [1.7.0] - 2022-02-22
109* The new [`hx-sync`](https://htmx.org/attributes/hx-sync) attribute allows you to synchronize multiple element requests on a single
110 element using various strategies (e.g. replace)
111 * You can also now abort an element making a request by sending it the `htmx:abort` event
112* [Server Sent Events](/extensions/server-sent-events) and [Web Sockets](/extensions/web-sockets) are now available as
113 extensions, in addition to the normal core support. In htmx 2.0, the current `hx-sse` and `hx-ws` attributes will be
114 moved entirely out to these new extensions. By moving these features to extensions we will be able to add functionality
115 to both of them without compromising the core file size of htmx. You are encouraged to move over to the new
116 extensions, but `hx-sse` and `hx-ws` will continue to work indefinitely in htmx 1.x.
117* You can now mask out [attribute inheritance](/docs#inheritance) via the [`hx-disinherit`](https://htmx.org/attributes/hx-disinherit) attribute.
118* The `HX-Push` header can now have the `false` value, which will prevent a history snapshot from occuring.
119* Many new extensions, with a big thanks to all the contributors!
120 * A new [`alpine-morph`](/extensions/alpine-morph) allows you to use Alpine's swapping engine, which preserves Alpine
121 * A [restored](/extensions/restored) extension was added that will trigger a `restore` event on all elements in the DOM
122 on history restoration.
123 * A [loading-states](/extensions/loading-states) extension was added that allows you to easily manage loading states
124 while a request is in flight, including disabling elements, and adding and removing CSS classes.
125* The `this` symbol now resolves properly for the [`hx-include`](https://htmx.org/attributes/hx-include) and [`hx-indicator`](https://htmx.org/attributes/hx-indicator)
126 attributes
127* When an object is included via the [`hx-vals`](https://htmx.org/attributes/hx-vals) attribute, it will be converted to JSON (rather
128 than rendering as the string `[Object object]"`)
129* You can now pass a swap style in to the `htmx.ajax()` function call.
130* Poll events now contain a `target` attribute, allowing you to filter a poll on the element that is polling.
131* Two new Out Of Band-related events were added: `htmx:oobBeforeSwap` & `htmx:oobAfterSwap`
133## [1.6.1] - 2021-11-22
135* A new `HX-Retarget` header allows you to change the default target of returned content
136* The `htmx:beforeSwap` event now includes another configurable property: `detail.isError` which can
137 be used to indicate if a given response should be treated as an error or not
138* The `htmx:afterRequest` event has two new detail properties: `success` and `failed`, allowing you to write
139 trigger filters in htmx or hyperscript:
140 ```applescript
141 on htmx:afterRequest[failed]
142 set #myCheckbox's checked to true
143 ```
144* Fixed the `from:` option in [`hx-trigger`](https://htmx.org/attributes/hx-trigger) to support `closest <CSS selector>`
145 and `find <CSS selector>` forms
146* Don't boost anchor tags with an explicit `target` set
147* Don't cancel all events on boosted elements, only the events that naturally trigger them (click for anchors, submit
148 for forms)
149* Persist revealed state in the DOM so that on history navigation, revealed elements are not re-requested
150* Process all [`hx-ext`](https://htmx.org/attributes/hx-ext) attributes, even if no other htmx attribute is on the element
151* Snapshot the current URL on load so that history support works properly after a page refresh occurs
152* Many, many documentation updates (thank you to all the contributors!)
155## [1.6.0] - 2021-10-01
157* Completely reworked `<script>` tag support that now supports the `<script src="...'/>` form
158* You can now use the value `unset` to clear a property that would normally be inherited (e.g. hx-confirm)
159* The `htmx-added` class is added to new content before a swap and removed after the settle phase, which allows you
160 more flexibility in writing CSS transitions for added content (rather than relying on the target, as with `htmx-settling`)
161* The `htmx:beforeSwap` event has been updated to allow you to [configure swapping](https://htmx.org/docs/#modifying_swapping_behavior_with_events)
162 behavior
163* Improved `<title>` extraction support
164* You can listen to events on the `window` object using the `from:` modifier in `hx-trigger`
165* The `root` option of the `intersect` event was fixed
166* Boosted forms respect the `enctype` declaration
167* The `HX-Boosted` header will be sent on requests from boosted elements
168* Promises are not returned from the main ajax function unless it is an api call (i.e. `htmx.ajax`)
170## [1.5.0] - 2021-7-12
172* Support tracking of button clicked during a form submission
173* Conditional polling via the [hx-trigger](https://htmx.org/attributes/hx-trigger) attribute
174* `document` is now a valid pseudo-selector on the [hx-trigger](https://htmx.org/attributes/hx-trigger) `from:` argument, allowing you
175 to listen for events on the document.
176* Added the [hx-request](https://htmx.org/attributes/hx-request) attribute, allowing you to configure the following aspects of the request
177 * `timeout` - the timeout of the request
178 * `credentials` - if the request will send credentials
179 * `noHeaders` - strips all headers from the request
180* Along with the above attribute, you can configure the default values for each of these via the corresponding `htmx.config`
181 properties (e.g. `htmx.config.timeout`)
182* Both the `scroll` and `show` options on [hx-swap](https://htmx.org/attributes/hx-swap) now support extended syntax for selecting the
183 element to scroll or to show, including the pseudo-selectors `window:top` and `window:bottom`.
185## [1.4.1] - 2021-6-1
187* typo fix
189## [1.4.0] - 2021-5-25
191* Added the `queue` option to the [hx-trigger](https://htmx.org/attributes/hx-trigger) attribute, allowing you to specify how events
192 should be queued when they are received with a request in flight
193* The `htmx.config.useTemplateFragments` option was added, allowing you to use HTML template tags for parsing content
194 from the server. This allows you to use Out of Band content when returning things like table rows, but it is not
195 IE11 compatible.
196* The `defaultSettleDelay` was dropped to 20ms from 100ms
197* Introduced a new synthetic event, [intersect](https://htmx.org/docs#pecial-events) that allows you to trigger when an item is scrolled into view
198 as specified by the `IntersectionObserver` API
199* Fixed timing issue that caused exceptions in the `reveal` logic when scrolling at incredible speeds - <https://github.com/bigskysoftware/htmx/issues/463>
200* Fixed bug causing SVG titles to be incorrectly used as page title - <https://github.com/bigskysoftware/htmx/issues/459>
201* Boosted forms that issue a GET will now push the URL by default - <https://github.com/bigskysoftware/htmx/issues/485>
202* Better dispatch of request events when an element is removed from the DOM
203* Fixed a bug causing `hx-prompt` to fail
204* The `htmx.config.withCredentials` option was added, to send credentials with ajax requests (default is `false`)
205* The `throttle` option on `hx-trigger` does not delay the initial request any longer
206* The `meta` key is ignored on boosted links
207* `<script>` tags are now evaluated in the global scope
208* `hx-swap` now supports the `none` option
209* Safari text selection bug - <https://github.com/bigskysoftware/htmx/issues/438>
211## [1.3.3] - 2021-4-5
213* Added the [`hx-disabled`](https://htmx.org/docs#security) attribute to allow htmx to be turned off for parts of the DOM
214* SSE now uses a full-jitter exponential backoff algorithm on reconnection, using the `htmx.config.wsReconnectDelay`
215 setting
217## [1.3.2] - 2021-3-9
219* Bug fixes
221## [1.3.1] - 2021-3-9
223* IE11 fixes
225## [1.3.0] - 2021-3-6
227* Support a `target` modifier on `hx-trigger` to filter based on the element targeted by an event. This allows
228 lazy binding to that target selector.
229* Events are no longer consumed by the first element that might handle them, unless the `consume` keyword is
230 added to the `hx-trigger` specification
231* Added the `htmx:beforeSend` event, fired just before an ajax request begins
232* SSE swaps are properly settled
233* Fixed bug that was improperly cancelling all clicks on anchors
234* `htmx.ajax()` now returns a promise
236## [1.2.1] - 2021-2-19
238* Fixed an issue with the history cache, where the cache was getting blown out after the first navigation backwards
239* Added the `htmx.config.refreshOnHistoryMiss` option, allowing users to trigger a full page refresh on history cache miss
240 rather than issuing an AJAX request
242## [1.2.0] - 2021-2-13
244### New Features
246* `hx-vars` has been deprecated in favor of `hx-vals`
247* `hx-vals` now supports a `javascript:` prefix to achieve the behavior that `hx-vars` provided
248* The new `hx-headers` attribute allows you to add headers to a request via an attribute. Like `hx-vals` it supports
249 JSON or javascript via the `javascript:` prefix
250* `hx-include` will now include all inputs under an element, even if that element is not a form tag
251* The [preload extension](https://htmx.org/extensions/preload/) now offers a `preload-images="true"` attribute that will aggressively load images in preloaded content
252* On requests driven by a history cache miss, the new `HX-History-Restore-Request` header is included so that the server
253 can differentiate between history requests and normal requests
255### Improvements & Bug fixes
257* Improved handling of precedence of input values to favor the enclosing form (see [here](https://github.com/bigskysoftware/htmx/commit/a10e43d619dc340aa324d37772c06a69a2f47ec9))
258* Moved event filtering logic *after* `preventDefault` so filtering still allows events to be properly handled
259* No longer trigger after swap events on elements that have been removed via an `outerHTML` swap
260* Properly remove event handlers added to other elements when an element is removed from the DOM
261* Handle the `scroll:` modifier in `hx-swap` properly when an `outerHTML` swap occurs
262* Lots of docs fixes
264## [1.1.0] - 2021-1-6
266* Newly added [preload extension](https://htmx.org/extensions/preload/) allows you to preload resources for lower
267 latency requests!
268* Support the `ignore:` modifier for extensions
269* Updated form variable order inclusion to include the enclosing form *last* so that, in the presence of multiple
270 values, the most relevant value is the most likely to be selected by the server
271* Support for the [`htmx.ajax()`](https://dev.htmx.org/api/#ajax) javascript function, to issue an htmx-style ajax
272 request from javascript
273* Removed the following htmx request headers for better cache behavior: `HX-Event-Target`, `HX-Active-Element`,
274 `HX-Active-Element-Name`, `HX-Active-Element-Value`
275* Added the [`hx-preserve`](https://dev.htmx.org/attributes/hx-preserve) attribute, which allows
276 you to preserve elements across requests (for example, to keep a video element playing properly)
277* The [path-deps](https://dev.htmx.org/extensions/path-deps/#refresh) now surfaces a small api
278 for refreshing path dependencies manually in javascript
279* Now support the `from:` clause on [`hx-trigger`](https://dev.htmx.org/attributes/hx-trigger) to
280 allow an element to respond to events on other elements.
281* Added the `htmx:beforeProcessNode` event, renamed the (previously undocumented) `htmx:processedNode` to `htmx:afterProcessNode`
282* Added `closest` syntax support for the [`hx-indicator`](https://dev.htmx.org/attributes/hx-indicator) attribute
283* Added `on load` support for the newest version of [hyperscript](https://hyperscript.org)
284* Added the `htmx.config.allowEval` configuration value, for CSP compatibility
285* Bug fixes & improvements
287## [1.0.2] - 2020-12-12
289* Extend all API methods to take a string selector as well as an element
290* Out of band swap elements need not be top level now
291* [`hx-swap-oob`](https://htmx.org/attributes/hx-swap-oob) now can accept a CSS selector to retarget with
293## [1.0.1] - 2020-12-04
295* AJAX file upload now correctly fires events, allowing for [a proper progress bar](https://htmx.org/examples/file-upload)
296* htmx api functions that expect an element now can accept a string selector instead:
297 ```js
298 htmx.on('#form', 'htmx:xhr:progress', function(evt) {
299 htmx.find('#progress').setAttribute('value', evt.detail.loaded/evt.detail.total * 100)
300 });
301 ```
302* htmx now properly handles the `multiple` attribute on `<select>` elements
304## [1.0.0] - 2020-11-24
306* Bumped the release version :)
308## [0.4.1] - 2020-11-23
310* Fixed bug with title tag support when title tag contained HTML entities
311* Pass properties for the `loadstart`, `loadend`, `progress`, `abort` events through properly to the htmx equivalents
313## [0.4.0] - 2020-11-16
315* Now support the `HX-Redirect` and `HX-Refresh` response headers for redirecting client side and triggering a page refresh, respectively
316* `hx-vars` now overrides input values
317* `<title>` tags in responses will be used to update page titles
318* All uses of `eval()` have been removed in favor of `Function`
319* [`hx-vals`](https://htmx.org/attributes/hx-vals) is available as a safe alternative to `hx-vars`. It uses `JSON.parse()` rather than evaluation, if you wish to safely pass user-provided values through to htmx.
321## [0.3.0] - 2020-10-27
323* `hx-trigger` parsing has been rewritten and now supports [trigger filters](https://htmx.org/docs/#trigger-filters) to filter
324 events based on arbitrary javascript expressions
325* htmx now supports two additional response headers `HX-Trigger-After-Swap` and `HX-Trigger-After-Settle` allowing
326 an event to be triggered after a given life cycle event (instead of before the swap)
327* The `requestConfig` is now passed out to events surrounding the AJAX life cycle
328* htmx now evaluates `<script>` tags as javascript when no language is defined on them
329* A new [`event-header`](https://htmx.org/extensions/event-header) extension, which will include a serialized JSON representation of the triggering event in requests
331## [0.2.0] - 2020-9-30
333* AJAX file upload [support](https://htmx.org/docs#files)
334* The HTML validation API is [respected](https://htmx.org/docs#validation)
336## [0.1.0] - 2020-9-18
338* *BREAKING CHANGE*: The SSE attribute [`hx-sse`](https://htmx.org/attributes/hx-sse/) and the Web Sockets attribute [`hx-ws`](https://htmx.org/attributes/hx-ws) have changed syntax to now use colon separators: `hx-sse='connect:/chat swap:message'`
339* The SSE attribute [`hx-sse`](https://htmx.org/attributes/hx-sse/) allows for swapping content directly on an event, in addition to triggering an htmx element,
340with the new `swap:<event name>` syntax.
341* [`hx-target`](https://htmx.org/attributes/hx-target) now supports a `find` syntax to find elements below the element by a CSS selector
342* htmx plays better with deferred loading and many package managers
343* All htmx events are dispatched in both camelCase as well as kebab-case, for better compatibility with AlpineJS and other frameworks. (e.g. `htmx:afterOnLoad` will also be triggered as
345* [hypeerscript](https://hyperscript.org) is now initialized independently of htmx
347## [0.0.8] - 2020-7-8
349* The `view` modifier on `hx-swap` has been renamed to `show`: `hx-swap='innerHTML show:top'`
351## [0.0.7] - 2020-6-30
353* The [`hx-swap`](https://htmx.org/attributes/hx-swap) attribute now supports two new modifiers:
354 * `scroll` - allows you to scroll the target to the `top` or `bottom`
355 * `view` - allows you to scroll the `top` or `bottom` of the target into view
356* The [`hx-push-url`](https://htmx.org/attributes/hx-push-url) attribute now can optionally take a URL to push, in addition to `true` and `false`
357* Added the [`hx-vars`](https://htmx.org/attributes/hx-vars) attribute that allows you to dynamically add to the parameters that will be submitted with a request
359## [0.0.6] - 2020-6-20
361* Custom request/response headers no longer start with the `X-` prefix, which is no longer recommended
362* empty verb attributes are now allowed and follow the anchor tag semantics (e.g. `<div hx-get></div>`)
363* nunjuks inline rendering is now supported in the `client-side-templates` extension
364* the new `ajax-header` extension includes the `X-Requested-With` header
365* bad JSON is now handled more gracefully
366* `hx-swap="none"` will cause no swap to take place <https://github.com/bigskysoftware/htmx/issues/89>
367* `hx-trigger` now supports a `throttle` modifier <https://github.com/bigskysoftware/htmx/issues/88>
368* the focused element is preserved if possible after a replacement
369* perf improvements for large DOM trees with sparse `hx-` annotations
371## [0.0.4] - 2020-5-24
373* Extension mechanism added
374* SSE support added
375* WebSocket support added
377## [0.0.3] - 2020-5-17
379* Renamed to htmx
380* A bug fix for the `hx-prompt` attribute
381* A bug fix for multiple `hx-swap-oob` attributes
382* Moved the default CSS indicator injection into its own sheet to avoid breaking
383* Added the `htmx.config.includeIndicatorStyles` configuration option so people can opt out of injecting the indicator CSS
386## [0.0.1] - 2020-5-15
388* Initial release (originally named kutty)
\No newline at end of file