Skip to content

docs: clarify afterRequest successful/failed reflect responseHandling rule (#3440) #3770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
manwithacat wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −4
Open

docs: clarify afterRequest successful/failed reflect responseHandling rule (#3440) #3770

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions www/content/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,14 @@ can be paired with [`htmx:beforeRequest`](#htmx:beforeRequest) to wrap behavior
* `detail.xhr` - the `XMLHttpRequest`
* `detail.target` - the target of the request
* `detail.requestConfig` - the configuration of the AJAX request
* `detail.successful` - true if the response has a 20x status code or is marked `detail.isError = false` in the
`htmx:beforeSwap` event, else false
* `detail.failed` - true if the response does not have a 20x status code or is marked `detail.isError = true` in the
`htmx:beforeSwap` event, else false
* `detail.successful` - true if the response is not marked as an error by the matched
[`htmx.config.responseHandling`](@/docs.md#response-handling) rule (by default, a 20x status code) or is marked
`detail.isError = false` in the `htmx:beforeSwap` event, else false. Note that if you customize
`responseHandling` to allow non-2xx codes to swap (e.g. `{"code":"...", "swap": true}` without `error: true`),
those responses will also be marked `successful` here.
* `detail.failed` - true if the response is marked as an error by the matched
[`htmx.config.responseHandling`](@/docs.md#response-handling) rule (by default, a non-20x status code) or is marked
`detail.isError = true` in the `htmx:beforeSwap` event, else false

### Event - `htmx:afterSettle` {#htmx:afterSettle}

Expand Down
Loading