Repository navigation
http: send HX-Request-Type from HTMX 1.x and 2.x - #87
Merged
Merged
Conversation
HTMX 4.x tells the server whether it expects a fragment or a full page. HTMX 1.x and 2.x do not, and the other headers cannot answer it: HX-Target holds only an ID, and hx-select never reaches the server. An endpoint that returned a partial for every HTMX request therefore broke boosted navigation and hx-select, which expect the full page. - Add HX-Request-Type in the companion script for HTMX 1.x and 2.x, computed the way HTMX 4.x does: "full" when the target is the body or a selector applies, "partial" otherwise. The header is set in htmx:beforeRequest, the first event that sees the select of htmx.ajax and HX-Location requests. Requests with noHeaders in hx-request and requests that already set the header are left as is. - Report history restoration requests without the header as Full in RequestType and IsHtmxFullRequest. HTMX 1.x and 2.x send them without it; HTMX 4.x sends "full". - Use IsHtmxPartialRequest in the README and articles to serve a page and its fragment from one URL.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
HTMX 4.x tells the server whether it expects a fragment or a full page. HTMX 1.x and 2.x do not, and the other headers cannot answer it, so
IsHtmxPartialRequest()and[HtmxRequest(RequestType = ...)]worked only with HTMX 4.x.HX-Request-Typefor HTMX 1.x and 2.x, computed the way HTMX 4.x does:fullwhen the target is the body or a selector applies,partialotherwise. It is set inhtmx:beforeRequest, the first event that sees theselectofhtmx.ajaxandHX-Locationrequests.Requests with
noHeadersinhx-requestand requests that already set the header are left as is.RequestTypeandIsHtmxFullRequest()report a history restoration request without the header asFull.HTMX 1.x and 2.x send it without the header; HTMX 4.x sends
full.Verification
Unit tests cover the server side. The script was checked in Chromium against HTMX 1.9.12, 2.0.11 and 4.0.0, both
htmx-toolkit.jsandhtmx-toolkit.min.js, with these cases:hx-target: an inner element andbodyhx-select: on the element, inherited,unset, and withhx-disinherithx-targethtmx.ajaxwith and withoutselectandtargetHX-Locationwith and withoutselectnoHeaders: on the element, inherited, overridden, and the unbraced formHX-Request-Typeset withhx-headersHTMX 1.x and 2.x send the expected value in every case. HTMX 4.x keeps its own header, and no request carries two values.
Known limit: an
hx-requestvalue that starts withjs:is not evaluated, so it cannot turn the header off.