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