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