Ything-RepoMirrors/htmx
1
0
Fork 0
mirror of https://github.com/bigskysoftware/htmx.git synced 2026-01-25 05:06:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Carson Gross
2025-12-24 14:05:53 -07:00
parent 017934f816
commit 50fbb1f91d
4 changed files with 26 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
www/content/events.md
View File

@@ -209,15 +209,25 @@ This event is triggered after new content has been swapped into the DOM.
* `detail.ctx` - the request context object
### Event - `htmx:after:restore` {#htmx:after:restore}
### Event - `htmx:before:settle` {#htmx:before:settle}
This event is triggered after all content has been restored to the DOM following a swap operation. This includes after any restore tasks (like CSS transitions) have been completed.
This is useful for performing final cleanup or initialization after all swap-related operations are complete.
This event is triggered before the settle phase begins, after content has been swapped into the DOM but before CSS transitions are applied.
##### Details
* `detail.ctx` - the request context object
* `detail.task` - the swap task being settled
* `detail.newContent` - array of newly swapped content elements
* `detail.settleTasks` - array of settle tasks (e.g., CSS transition callbacks)
### Event - `htmx:after:settle` {#htmx:after:settle}
This event is triggered after the settle phase completes, including after any settle tasks (like CSS transitions) have finished.
##### Details
* `detail.task` - the swap task that was settled
* `detail.newContent` - array of newly settled content elements
* `detail.settleTasks` - array of settle tasks that were executed
## History Events

13
www/content/extensions/building.md
View File

@@ -84,12 +84,13 @@ of colons:
### Swap Events
| Hook Name | Triggered Event | Parameters | Description |
| -------------------- | -------------------- | --------------- | ----------------------- |
| `htmx_before_swap` | `htmx:before:swap` | `(elt, detail)` | Before content swap |
| `htmx_after_swap` | `htmx:after:swap` | `(elt, detail)` | After content swap |
| `htmx_after_restore` | `htmx:after:restore` | `(elt, detail)` | After restoring content |
| `htmx_handle_swap` | `htmx:handle:swap` | `(elt, detail)` | Custom swap handler |
| Hook Name | Triggered Event | Parameters | Description |
| --------------------- | --------------------- | --------------- | ----------------------- |
| `htmx_before_swap` | `htmx:before:swap` | `(elt, detail)` | Before content swap |
| `htmx_after_swap` | `htmx:after:swap` | `(elt, detail)` | After content swap |
| `htmx_before_settle` | `htmx:before:settle` | `(elt, detail)` | Before settle phase |
| `htmx_after_settle` | `htmx:after:settle` | `(elt, detail)` | After settle phase |
| `htmx_handle_swap` | `htmx:handle:swap` | `(elt, detail)` | Custom swap handler |
### History Events

3
www/content/htmx-4.md
View File

@@ -187,7 +187,8 @@ major changes between htmx 2.x and htmx 4.x.
- `htmx:after:cleanup` - fires after element cleanup completes
- `htmx:after:history:update` - fires after history state is updated
- `htmx:after:process` - fires after element processing completes
- `htmx:after:restore` - fires after restore tasks complete in swap
- `htmx:before:settle` - fires before settle phase begins
- `htmx:after:settle` - fires after settle phase completes
- `htmx:finally:request` - fires in finally block after request (success or error)
- `htmx:before:sse:stream` - fires before SSE stream begins
- `htmx:after:sse:stream` - fires after SSE stream ends

3
www/content/migration-guide-htmx-4.md
View File

@@ -160,7 +160,8 @@ If you need upload progress tracking in htmx 4:
* `htmx:after:cleanup` - Triggered after element cleanup
* `htmx:after:history:update` - Triggered after history is updated
* `htmx:after:process` - Triggered after processing an element
* `htmx:after:restore` - Triggered after all restore tasks complete
* `htmx:before:settle` - Triggered before settle phase begins
* `htmx:after:settle` - Triggered after settle phase completes
* `htmx:after:viewTransition` - Triggered after view transition completes
* `htmx:after:sse:message` - Triggered after processing an SSE message
* `htmx:after:sse:stream` - Triggered after an SSE stream ends