itsscb/htmx
1
0
Fork 0
mirror of https://github.com/bigskysoftware/htmx.git synced 2025-10-03 07:45:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

add instructions for using htmx.ajax() with a callback

Browse Source 
Added some info about how `htmx.ajax()` returns a Promise, which can be paired with a callback to execute code after the content has been inserted into the DOM.
This commit is contained in:
arcanemachine 2022-01-11 03:35:16 -07:00 committed by Nicholas Moen
parent c2cb238184
commit 6132770a8f
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
www/api.md
View File

@ -28,7 +28,7 @@ This method adds a class to the given element.
### <a name="ajax"></a> Method - [`htmx.ajax()`](#ajax)
Issues an htmx-style AJAX request
Issues an htmx-style AJAX request. This method returns a Promise, so a callback can be executed after the content has been inserted into the DOM.
##### Parameters
@ -60,6 +60,13 @@ or
```js
// issue a GET to /example and put the response HTML into #myDiv
htmx.ajax('GET', '/example', '#myDiv')
// execute some code after the content has been inserted into the DOM
htmx.ajax('GET', '/example', '#myDiv').then(() => {
// this code will be executed after the 'htmx:afterOnLoad' event,
// and before the 'htmx:xhr:loadend' event
console.log('Content inserted successfully!');
});
```
### <a name="closest"></a> Method - [`htmx.closest()`](#closest)