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