Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/dev' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
1cg committed Nov 7, 2023
2 parents 6fe6258 + 563ce5d commit d1cb1ac
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions www/content/attributes/hx-include.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,19 @@
title = "hx-include"
+++

The `hx-include` attribute allows you to include additional element values in an AJAX request. The value of
this attribute is a CSS query selector of the element or elements to include in the query.
The `hx-include` attribute allows you to include additional element values in an AJAX request. The value of this
attribute can be:

* A CSS query selector of the elements to include.
* `this` which will include the descendants of the element.
* `closest <CSS selector>` which will find the [closest](https://developer.mozilla.org/docs/Web/API/Element/closest)
ancestor element or itself, that matches the given CSS selector
(e.g. `closest tr` will target the closest table row to the element).
* `find <CSS selector>` which will find the first child descendant element that matches the given CSS selector.
* `next <CSS selector>` which will scan the DOM forward for the first element that matches the given CSS selector.
(e.g. `next .error` will target the closest following sibling element with `error` class)
* `previous <CSS selector>` which will scan the DOM backwards for the first element that matches the given CSS selector.
(e.g `previous .error` will target the closest previous sibling with `error` class)

Here is an example that includes a separate input value:

Expand All @@ -24,3 +35,19 @@ Note that if you include a non-input element, all input elements enclosed in tha
## Notes

* `hx-include` is inherited and can be placed on a parent element
* While `hx-include` is inherited, it is evaluated from the element triggering the request. It is easy to get confused
when working with the extended selectors such as `find` and `closest`.
```html
<div hx-include="find input">
<button hx-post="/register">
Register!
</button>
Enter email: <input name="email" type="email"/>
</div>
```
In the above example, when clicking on the button, the `find input` selector is resolved from the button itself, which
does not return any element here, since the button doesn't have any `input` child, thus in this case, raises an error.
* A standard CSS selector resolves
to [document.querySelectorAll](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll) and will include
multiple elements, while the extended selectors such as `find` or `next` only return a single element at most to
include

0 comments on commit d1cb1ac

Please sign in to comment.