UNPKG

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