KTOR-7584 HTMX extension for Ktor #4553
Conversation
| header(HxRequestHeaders.Request, "true") { | ||
| configuration() | ||
| } |
There was a problem hiding this comment.
Probably this header should be applied to the route passed in HxRoute constructor:
public value class HxRoute(route: Route) : Route by route.header(HxRequestHeaders.Request, "true") {| @ExperimentalHtmxApi | ||
| @KtorDsl | ||
| @JvmInline | ||
| public value class HXRoute(private val route: Route) : Route by route { |
There was a problem hiding this comment.
Minor
| public value class HXRoute(private val route: Route) : Route by route { | |
| public value class HxRoute(private val route: Route) : Route by route { |
| client.get("htmx") { | ||
| headers[HxRequestHeaders.Request] = "true" | ||
| headers[HxRequestHeaders.Trigger] = "#button" | ||
| }.bodyAsText().trim() |
There was a problem hiding this comment.
Could you also add negative tests?
|
|
||
| @ExperimentalHtmxApi | ||
| @HtmlTagMarker | ||
| public class HxAttributes(override val map: DelegatingMap) : StringMapDelegate { |
There was a problem hiding this comment.
Should this be in a shared module?
|
|
||
| public object HxAttributeKeys { | ||
| /** | ||
| * issues a GET to the specified URL |
There was a problem hiding this comment.
Here and in some other files KDocs are starting with a lowercase letter. Could you fix it?
I also think that we could add a link to the official docs to the KDoc of this class: https://htmx.org/reference/#attributes-additional
| public var location: String? by HxResponseHeaders.Location | ||
| public var pushUrl: String? by HxResponseHeaders.PushUrl | ||
| public var redirect: String? by HxResponseHeaders.Redirect | ||
| public var refresh: String? by HxResponseHeaders.Refresh // TODO boolean |
There was a problem hiding this comment.
Should we make it boolean now? Or ExperimentalHtmxApi allows breaking changes? 😅
| public val on: On | ||
| get() = On(map) | ||
|
|
||
| public fun on(event: String, script: String) { | ||
| map["hx-on:$event"] = script | ||
| } |
There was a problem hiding this comment.
I don't remember what we decided here. Keep both options of syntax?
on["event] = "script"
on("event", "script")| public var pushUrl: String? by HxAttributeKeys.PushUrl | ||
| public var select: String? by HxAttributeKeys.Select | ||
| public var selectOob: String? by HxAttributeKeys.SelectOob | ||
| public var swap: String? by HxAttributeKeys.Swap |
There was a problem hiding this comment.
We've had type-safe implementations for some of these fields. Will it be part of some future PR?
osipxd
force-pushed
the
3.1.0-eap
branch
2 times, most recently
from
7c22c8a to
f555d1a
Compare
osipxd
force-pushed
the
3.1.0-eap
branch
5 times, most recently
from
2c3b4d8 to
4a59355
Compare
bjhham
force-pushed
the
bjhham/htmx-ext
branch
from
466444a to
0767037
Compare
Subsystem
Server, New plugin
Motivation
KTOR-7584 First-class HTMX support
Solution
This extends the routing and HTML builder DSL with some handy HTMX helpers. I tried to ere on the conservative side here by not including everything and adding an experimental flag so we can change things later after testing. We don't have the HTML fragments extension yet in the HTML DSL, but you can still do everything you need using valid HTML and attributes.