WIP on docs

- bump version

.github/workflows/ci.yml

@@ -17,9 +17,9 @@ jobs:
         dotnet-version: [ "6.0", "7.0", "8.0" ]
     
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Setup .NET ${{ matrix.dotnet-version }}.x
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: ${{ matrix.dotnet-version }}.x
     - name: Restore dependencies
@@ -32,9 +32,9 @@ jobs:
     runs-on: ubuntu-latest
     needs: build-and-test
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Setup .NET
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: "8.0"
     - name: Package Common library
@@ -50,7 +50,7 @@ jobs:
     - name: Move View Engine package
       run: cp src/ViewEngine.Htmx/bin/Release/Giraffe.ViewEngine.Htmx.*.nupkg .
     - name: Save Packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: packages
         path: |

.gitignore

@@ -6,3 +6,6 @@
 .idea
 *.user
 .vscode
+src/*.nupkg
+src/tests*.txt
+

README.md

@@ -25,9 +25,10 @@ A server may want to respond to a request that originated from htmx differently
 // "view" can be whatever your view engine needs for the body of the page
 let result view : HttpHandler =
     fun next ctx ->
-      match ctx.Request.IsHtmx && not ctx.Request.IsHtmxRefresh with
+        if ctx.Request.IsHtmx && not ctx.Request.IsHtmxRefresh then
-      | true -> partial view
+            partial view
-      | false -> full view
+        else
+            full view
 ```
 
 htmx also utilizes [response headers](https://htmx.org/docs/#response_headers) to affect client-side behavior. For each of these, this library provides `HttpHandler`s that can be chained along with the response. As an example, if the server returns a redirect response (301, 302, 303, 307), the `XMLHttpRequest` handler on the client will follow the redirection before htmx can do anything with it. To redirect to a new page, you would return an OK (200) response with an `HX-Redirect` header set in the response.
@@ -49,7 +50,9 @@ As an example, creating a `div` that loads data once the HTML is rendered:
 
 ```fsharp
 let autoload =
-    div [ _hxGet "/lazy-load-data"; _hxTrigger "load" ] [ str "Loading..." ]
+    div [ _hxGet "/lazy-load-data"; _hxTrigger HxTrigger.Load ] [
+        str "Loading..."
+    ]
 ```
 
 _(As `hx-boost="true"` is the usual desire for boosting, `_hxBoost` implies true. To disable it for an element, use `_hxNoBoost` instead.)_

src/Common/Common.fs

@@ -1,28 +1,45 @@
-/// Common definitions shared between attribute values and response headers
+/// <summary>Common definitions shared between attribute values and response headers</summary>
 [<AutoOpen>]
 module Giraffe.Htmx.Common
 
-/// Valid values for the `hx-swap` attribute / `HX-Reswap` header (may be combined with swap/settle/scroll/show config)
+/// <summary>Serialize a list of key/value pairs to JSON (very rudimentary)</summary>
+/// <param name="pairs">The key/value pairs to be serialized to JSON</param>
+/// <returns>A string with the key/value pairs serialized to JSON</returns>
+let internal toJson (pairs: (string * string) list) =
+    pairs
+    |> List.map (fun pair -> sprintf "\"%s\": \"%s\"" (fst pair) ((snd pair).Replace ("\"", "\\\"")))
+    |> String.concat ", "
+    |> sprintf "{ %s }"
+
+/// <summary>Convert a boolean to lowercase <tt>true</tt> or <tt>false</tt></summary>
+/// <param name="boolValue">The boolean value to convert</param>
+/// <returns>"true" for <tt>true</tt>, "false" for <tt>false</tt></returns>
+let internal toLowerBool (boolValue: bool) =
+    (string boolValue).ToLowerInvariant()
+
+
+/// <summary>Valid values for the <tt>hx-swap</tt> attribute / <tt>HX-Reswap</tt> header</summary>
+/// <remarks>May be combined with <tt>swap</tt> / <tt>settle</tt> / <tt>scroll</tt> / <tt>show</tt> config)</remarks>
 [<RequireQualifiedAccess>]
 module HxSwap =
     
-    /// The default, replace the inner html of the target element
+    /// <summary>The default, replace the inner HTML of the target element</summary>
     let InnerHtml = "innerHTML"
     
-    /// Replace the entire target element with the response
+    /// <summary>Replace the entire target element with the response</summary>
     let OuterHtml = "outerHTML"
     
-    /// Insert the response before the target element
+    /// <summary>Insert the response before the target element</summary>
     let BeforeBegin = "beforebegin"
     
-    /// Insert the response before the first child of the target element
+    /// <summary>Insert the response before the first child of the target element</summary>
     let AfterBegin = "afterbegin"
     
-    /// Insert the response after the last child of the target element
+    /// <summary>Insert the response after the last child of the target element</summary>
     let BeforeEnd = "beforeend"
     
-    /// Insert the response after the target element
+    /// <summary>Insert the response after the target element</summary>
     let AfterEnd = "afterend"
     
-    /// Does not append content from response (out of band items will still be processed).
+    /// <summary>Does not append content from response (out of band items will still be processed).</summary>
     let None = "none"

src/Common/Giraffe.Htmx.Common.fsproj

@@ -4,6 +4,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Description>Common definitions for Giraffe.Htmx</Description>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -16,4 +17,8 @@
     <PackageReference Update="FSharp.Core" Version="6.0.0" />
   </ItemGroup>
   
+  <ItemGroup>
+    <InternalsVisibleTo Include="Giraffe.Htmx" />
+    <InternalsVisibleTo Include="Giraffe.ViewEngine.Htmx" />
+  </ItemGroup>
 </Project>

src/Common/README.md

@@ -2,4 +2,4 @@
 
 This package contains common code shared between [`Giraffe.Htmx`](https://www.nuget.org/packages/Giraffe.Htmx) and [`Giraffe.ViewEngine.Htmx`](https://www.nuget.org/packages/Giraffe.ViewEngine.Htmx), and will be automatically installed when you install either one.
 
-**htmx version: 2.0.0-alpha2**
+**htmx version: 2.0.4**

src/Directory.Build.props

@@ -1,18 +1,18 @@
 <?xml version="1.0" encoding="utf-8" standalone="no"?>
 <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
     <PropertyGroup>
-        <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
+        <TargetFrameworks>net8.0;net9.0</TargetFrameworks>
-        <VersionPrefix>2.0.0</VersionPrefix>
+        <VersionPrefix>2.0.5</VersionPrefix>
-        <VersionSuffix>alpha2</VersionSuffix>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
-        <PackageReleaseNotes>Update script tags to pull htmx 2.0.0-alpha2; remove deprecated _hxOn attribute</PackageReleaseNotes>
+        <PackageReleaseNotes>Add full packaged XML documentation; update script tags to pull htmx 2.0.5 (no header or attribute changes)</PackageReleaseNotes>
         <Authors>danieljsummers</Authors>
         <Company>Bit Badger Solutions</Company>
-        <PackageProjectUrl>https://github.com/bit-badger/Giraffe.Htmx</PackageProjectUrl>
+        <PackageProjectUrl>https://git.bitbadger.solutions/bit-badger/Giraffe.Htmx</PackageProjectUrl>
         <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
-        <RepositoryUrl>https://github.com/bit-badger/Giraffe.Htmx</RepositoryUrl>
+        <RepositoryUrl>https://git.bitbadger.solutions/bit-badger/Giraffe.Htmx</RepositoryUrl>
         <RepositoryType>Git</RepositoryType>
         <Copyright>MIT License</Copyright>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
-        <PackageTags>Giraffe htmx alpha</PackageTags>
+        <PackageTags>Giraffe htmx</PackageTags>
     </PropertyGroup>
 </Project>

src/Htmx/Giraffe.Htmx.fsproj

@@ -4,6 +4,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Description>htmx header extensions and helpers for Giraffe</Description>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -13,7 +14,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Giraffe" Version="6.2.0" />
+    <PackageReference Include="Giraffe" Version="6.4.0" />
     <PackageReference Update="FSharp.Core" Version="6.0.0" />
   </ItemGroup>
 

src/Htmx/Htmx.fs

@@ -11,62 +11,67 @@ let private hdr (headers : IHeaderDictionary) hdr =
 /// Extensions to the header dictionary
 type IHeaderDictionary with
   
-    /// Indicates that the request is via an element using `hx-boost`
+    /// <summary>Indicates that the request is via an element using <tt>hx-boost</tt></summary>
-    member this.HxBoosted with get () = hdr this "HX-Boosted" |> Option.map bool.Parse
+    member this.HxBoosted
+        with get () = hdr this "HX-Boosted" |> Option.map bool.Parse
     
-    /// The current URL of the browser _(note that this does not update until after settle)_
+    /// <summary>The current URL of the browser <em>(note that this does not update until after settle)</em></summary>
-    member this.HxCurrentUrl with get () = hdr this "HX-Current-URL" |> Option.map Uri
+    member this.HxCurrentUrl
+        with get () = hdr this "HX-Current-URL" |> Option.map Uri
     
-    /// `true` if the request is for history restoration after a miss in the local history cache
+    /// <summary>
-    member this.HxHistoryRestoreRequest with get () = hdr this "HX-History-Restore-Request" |> Option.map bool.Parse
+    /// <tt>true</tt> if the request is for history restoration after a miss in the local history cache
+    /// </summary>
+    member this.HxHistoryRestoreRequest
+        with get () = hdr this "HX-History-Restore-Request" |> Option.map bool.Parse
     
-    /// The user response to an `hx-prompt`
+    /// <summary>The user response to an <tt>hx-prompt</tt></summary>
-    member this.HxPrompt with get () = hdr this "HX-Prompt"
+    member this.HxPrompt
+        with get () = hdr this "HX-Prompt"
 
-    /// `true` if the request came from HTMX
+    /// <summary><tt>true</tt> if the request came from htmx</summary>
-    member this.HxRequest with get () = hdr this "HX-Request" |> Option.map bool.Parse
+    member this.HxRequest
+        with get () = hdr this "HX-Request" |> Option.map bool.Parse
 
-    /// The `id` of the target element if it exists
+    /// <summary>The <tt>id</tt> attribute of the target element if it exists</summary>
-    member this.HxTarget with get () = hdr this "HX-Target"
+    member this.HxTarget
+        with get () = hdr this "HX-Target"
 
-    /// The `id` of the triggered element if it exists
+    /// <summary>The <tt>id</tt> attribute of the triggered element if it exists</summary>
-    member this.HxTrigger with get () = hdr this "HX-Trigger"
+    member this.HxTrigger
+        with get () = hdr this "HX-Trigger"
 
-    /// The `name` of the triggered element if it exists
+    /// <summary>The <tt>name</tt> attribute of the triggered element if it exists</summary>
-    member this.HxTriggerName with get () = hdr this "HX-Trigger-Name"
+    member this.HxTriggerName
+        with get () = hdr this "HX-Trigger-Name"
 
 
 /// Extensions for the request object
 type HttpRequest with
 
-    /// Whether this request was initiated from htmx
+    /// <summary>Whether this request was initiated from htmx</summary>
-    member this.IsHtmx with get () = this.Headers.HxRequest |> Option.defaultValue false
+    member this.IsHtmx
+        with get () = this.Headers.HxRequest |> Option.defaultValue false
 
-    /// Whether this request is an htmx history-miss refresh request
+    /// <summary>Whether this request is an htmx history-miss refresh request</summary>
-    member this.IsHtmxRefresh with get () =
+    member this.IsHtmxRefresh
-        this.IsHtmx && (this.Headers.HxHistoryRestoreRequest |> Option.defaultValue false)
+        with get () = this.IsHtmx && (this.Headers.HxHistoryRestoreRequest |> Option.defaultValue false)
 
 
-/// HTTP handlers for setting output headers
+/// <summary>HTTP handlers for setting output headers</summary>
 [<AutoOpen>]
 module Handlers =
 
-    /// Convert a boolean to lowercase `true` or `false`
+    open Giraffe.Htmx.Common
-    let private toLowerBool (trueOrFalse : bool) =
-        (string trueOrFalse).ToLowerInvariant ()
     
-    /// Serialize a list of key/value pairs to JSON (very rudimentary)
+    /// <summary>Pushes a new url into the history stack</summary>
-    let private toJson (evts : (string * string) list) =
+    /// <param name="url">The URL to be pushed</param>
-        evts
+    /// <returns>An HTTP handler with the <tt>HX-Push-Url</tt> header set</returns>
-        |> List.map (fun evt -> sprintf "\"%s\": \"%s\"" (fst evt) ((snd evt).Replace ("\"", "\\\"")))
+    let withHxPushUrl (url: string) : HttpHandler =
-        |> String.concat ", "
+        setHttpHeader "HX-Push-Url" url
-        |> sprintf "{ %s }"
 
-    /// Pushes a new url into the history stack
+    /// <summary>Explicitly do not push a new URL into the history stack</summary>
-    let withHxPushUrl : string -> HttpHandler =
+    /// <returns>An HTTP handler with the <tt>HX-Push-Url</tt> header set to <tt>false</tt></returns>
-        setHttpHeader "HX-Push-Url"
-
-    /// Explicitly do not push a new URL into the history stack
     let withHxNoPushUrl : HttpHandler =
         toLowerBool false |> withHxPushUrl
       
@@ -78,54 +83,80 @@ module Handlers =
     [<Obsolete "Use withHxNoPushUrl; HX-Push was replaced by HX-Push-Url in v1.8.0">]
     let withHxNoPush = withHxNoPushUrl
       
-    /// Can be used to do a client-side redirect to a new location
+    /// <summary>Can be used to do a client-side redirect to a new location</summary>
-    let withHxRedirect : string -> HttpHandler =
+    /// <param name="url">The URL to which the client should be redirected</param>
-        setHttpHeader "HX-Redirect"
+    /// <returns>An HTTP handler with the <tt>HX-Redirect</tt> header set</returns>
+    let withHxRedirect (url: string) : HttpHandler =
+        setHttpHeader "HX-Redirect" url
 
-    /// If set to `true` the client side will do a a full refresh of the page
+    /// <summary>If set to <tt>true</tt> the client side will do a full refresh of the page</summary>
-    let withHxRefresh : bool -> HttpHandler =
+    /// <param name="shouldRefresh">Whether the client should refresh their page</param>
-        toLowerBool >> setHttpHeader "HX-Refresh"
+    /// <returns>An HTTP handler with the <tt>HX-Refresh</tt> header set</returns>
+    let withHxRefresh shouldRefresh : HttpHandler =
+        (toLowerBool >> setHttpHeader "HX-Refresh") shouldRefresh
 
-    /// Replaces the current URL in the history stack
+    /// <summary>Replaces the current URL in the history stack</summary>
-    let withHxReplaceUrl : string -> HttpHandler =
+    /// <param name="url">The URL to place in the history stack in place of the current one</param>
-        setHttpHeader "HX-Replace-Url"
+    /// <returns>An HTTP handler with the <tt>HX-Replace-URL</tt> header set</returns>
+    let withHxReplaceUrl url : HttpHandler =
+        setHttpHeader "HX-Replace-Url" url
 
-    /// Explicitly do not replace the current URL in the history stack
+    /// <summary>Explicitly do not replace the current URL in the history stack</summary>
+    /// <returns>An HTTP handler with the <tt>HX-Replace-URL</tt> header set to <tt>false</tt></returns>
     let withHxNoReplaceUrl : HttpHandler =
         toLowerBool false |> withHxReplaceUrl
     
-    /// Override which portion of the response will be swapped into the target document
+    /// <summary>Override which portion of the response will be swapped into the target document</summary>
-    let withHxReselect : string -> HttpHandler =
+    /// <param name="target">The selector for the new response target</param>
-        setHttpHeader "HX-Reselect"
+    /// <returns>An HTTP handler with the <tt>HX-Reselect</tt> header set</returns>
+    let withHxReselect (target: string) : HttpHandler =
+        setHttpHeader "HX-Reselect" target
     
-    /// Override the `hx-swap` attribute from the initiating element
+    /// <summary>Override the <tt>hx-swap</tt> attribute from the initiating element</summary>
-    let withHxReswap : string -> HttpHandler =
+    /// <param name="swap">The swap value to override</param>
-        setHttpHeader "HX-Reswap"
+    /// <returns>An HTTP handler with the <tt>HX-Reswap</tt> header set</returns>
+    /// <remarks>Use <see cref="T:Giraffe.Htmx.Common.HxSwap">HxSwap</see> constants for best results</remarks>
+    let withHxReswap (swap: string) : HttpHandler =
+        setHttpHeader "HX-Reswap" swap
 
-    /// Allows you to override the `hx-target` attribute
+    /// <summary>Allows you to override the <tt>hx-target</tt> attribute</summary>
-    let withHxRetarget : string -> HttpHandler =
+    /// <param name="target">The new target for the response</param>
-        setHttpHeader "HX-Retarget"
+    /// <returns>An HTTP handler with the <tt>HX-Retarget</tt> header set</returns>
+    let withHxRetarget (target: string) : HttpHandler =
+        setHttpHeader "HX-Retarget" target
 
-    /// Allows you to trigger a single client side event
+    /// <summary>Allows you to trigger a single client side event</summary>
-    let withHxTrigger : string -> HttpHandler =
+    /// <param name="evt">The call to the event that should be triggered</param>
-        setHttpHeader "HX-Trigger"
+    /// <returns>An HTTP handler with the <tt>HX-Trigger</tt> header set</returns>
+    let withHxTrigger (evt: string) : HttpHandler =
+        setHttpHeader "HX-Trigger" evt
 
-    /// Allows you to trigger multiple client side events
+    /// <summary>Allows you to trigger multiple client side events</summary>
+    /// <param name="evts">The calls to events that should be triggered</param>
+    /// <returns>An HTTP handler with the <tt>HX-Trigger</tt> header set for all given events</returns>
     let withHxTriggerMany evts : HttpHandler =
         toJson evts |> setHttpHeader "HX-Trigger"
 
-    /// Allows you to trigger a single client side event after changes have settled
+    /// <summary>Allows you to trigger a single client side event after changes have settled</summary>
-    let withHxTriggerAfterSettle : string -> HttpHandler =
+    /// <param name="evt">The call to the event that should be triggered</param>
-        setHttpHeader "HX-Trigger-After-Settle"
+    /// <returns>An HTTP handler with the <tt>HX-Trigger-After-Settle</tt> header set</returns>
+    let withHxTriggerAfterSettle (evt: string) : HttpHandler =
+        setHttpHeader "HX-Trigger-After-Settle" evt
 
-    /// Allows you to trigger multiple client side events after changes have settled
+    /// <summary>Allows you to trigger multiple client side events after changes have settled</summary>
+    /// <param name="evts">The calls to events that should be triggered</param>
+    /// <returns>An HTTP handler with the <tt>HX-Trigger-After-Settle</tt> header set for all given events</returns>
     let withHxTriggerManyAfterSettle evts : HttpHandler =
         toJson evts |> setHttpHeader "HX-Trigger-After-Settle"
 
-    /// Allows you to trigger a single client side event after DOM swapping occurs
+    /// <summary>Allows you to trigger a single client side event after DOM swapping occurs</summary>
-    let withHxTriggerAfterSwap : string -> HttpHandler =
+    /// <param name="evt">The call to the event that should be triggered</param>
-        setHttpHeader "HX-Trigger-After-Swap"
+    /// <returns>An HTTP handler with the <tt>HX-Trigger-After-Swap</tt> header set</returns>
+    let withHxTriggerAfterSwap (evt: string) : HttpHandler =
+        setHttpHeader "HX-Trigger-After-Swap" evt
 
-    /// Allows you to trigger multiple client side events after DOM swapping occurs
+    /// <summary>Allows you to trigger multiple client side events after DOM swapping occurs</summary>
+    /// <param name="evts">The calls to events that should be triggered</param>
+    /// <returns>An HTTP handler with the <tt>HX-Trigger-After-Swap</tt> header set for all given events</returns>
     let withHxTriggerManyAfterSwap evts : HttpHandler =
         toJson evts |> setHttpHeader "HX-Trigger-After-Swap"

src/Htmx/README.md

@@ -2,13 +2,13 @@
 
 This package enables server-side support for [htmx](https://htmx.org) within [Giraffe](https://giraffe.wiki) and ASP.NET's `HttpContext`.
 
-**htmx version: 2.0.0-alpha2**
+**htmx version: 2.0.4**
 
-_Note that htmx 2.0 is an ALPHA release. The [migration guide](https://v2-0v2-0.htmx.org/migration-guide-htmx-1/) does not currently specify any request or response header changes. This means that, as of this release, there are no required code changes in moving to this major version._
+_Upgrading from v1.x: the [migration guide](https://htmx.org/migration-guide-htmx-1/) does not currently specify any request or response header changes. This means that there are no required code changes in moving from v1.* to v2.*._
 
 ### Setup
 
-1. Install the package (must use `--Prerelease` flag).
+1. Install the package.
 2. Prior to using the request header extension properties or the header-setting `HttpHandler`s, `open Giraffe.Htmx`.
 
 ### Use

src/Tests/Program.fs

@@ -3,4 +3,4 @@ open Expecto
 let allTests = testList "Giraffe" [ Common.allTests; Htmx.allTests; ViewEngine.allTests ]
 
 [<EntryPoint>]
-let main args = runTestsWithArgs defaultConfig args allTests
+let main args = runTestsWithCLIArgs [] args allTests

src/Tests/Tests.fsproj

@@ -18,8 +18,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Expecto" Version="9.0.4" />
+    <PackageReference Include="Expecto" Version="10.2.1" />
-    <PackageReference Include="NSubstitute" Version="5.0.0" />
+    <PackageReference Include="NSubstitute" Version="5.1.0" />
+    <PackageReference Update="FSharp.Core" Version="8.0.300" />
   </ItemGroup>
 
 </Project>

src/Tests/ViewEngine.fs

@@ -781,10 +781,6 @@ let attributes =
         test "_hxSelectOob succeeds" {
             section [ _hxSelectOob "#oob" ] [] |> shouldRender """<section hx-select-oob="#oob"></section>"""
         }
-        test "_hxSse succeeds" {
-            footer [ _hxSse "connect:/my-events" ] []
-            |> shouldRender """<footer hx-sse="connect:/my-events"></footer>"""
-        }
         test "_hxSwap succeeds" {
             del [ _hxSwap "innerHTML" ] [] |> shouldRender """<del hx-swap="innerHTML"></del>"""
         }
@@ -808,8 +804,11 @@ let attributes =
             dt [ _hxVals """{ "extra": "values" }""" ] []
             |> shouldRender """<dt hx-vals="{ &quot;extra&quot;: &quot;values&quot; }"></dt>"""
         }
-        test "_hxWs succeeds" {
+        test "_sseSwap succeeds" {
-            ul [ _hxWs "connect:/web-socket" ] [] |> shouldRender """<ul hx-ws="connect:/web-socket"></ul>"""
+            ul [ _sseSwap "sseMessageName" ] [] |> shouldRender """<ul sse-swap="sseMessageName"></ul>"""
+        }
+        test "_sseConnect succeeds" {
+            div [ _sseConnect "/gps/sse" ] [] |> shouldRender """<div sse-connect="/gps/sse"></div>"""
         }
     ]
 
@@ -820,14 +819,14 @@ let script =
             let html = RenderView.AsString.htmlNode Script.minified
             Expect.equal
                 html
-                """<script src="https://unpkg.com/htmx.org@2.0.0-alpha2" integrity="sha384-291pOdLqD0RmU6d5pyz/xmHmZZPhEv465X4AJDWvc8n0KrWrD65qaf2fk0xmsrJe" crossorigin="anonymous"></script>"""
+                """<script src="https://unpkg.com/htmx.org@2.0.4" integrity="sha384-HGfztofotfshcF7+8n44JQL2oJmowVChPTg48S+jvZoztPfvwD79OC/LTtG6dMp+" crossorigin="anonymous"></script>"""
                 "Minified script tag is incorrect"
         }
         test "unminified succeeds" {
             let html = RenderView.AsString.htmlNode Script.unminified
             Expect.equal
                 html
-                """<script src="https://unpkg.com/htmx.org@2.0.0-alpha2/dist/htmx.js" integrity="sha384-4Owd2qj8qFNBZ8QiR2ItYnNuMGgpOxaDT1uuRJXziuB1lvvKGYA/Lxy/oVM6q3h1" crossorigin="anonymous"></script>"""
+                """<script src="https://unpkg.com/htmx.org@2.0.4/dist/htmx.js" integrity="sha384-oeUn82QNXPuVkGCkcrInrS1twIxKhkZiFfr2TdiuObZ3n3yIeMiqcRzkIcguaof1" crossorigin="anonymous"></script>"""
                 "Unminified script tag is incorrect"
         }
     ]

src/ViewEngine.Htmx/Giraffe.ViewEngine.Htmx.fsproj

@@ -4,6 +4,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Description>Extensions to Giraffe View Engine to support htmx attributes and their values</Description>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

src/ViewEngine.Htmx/Htmx.fs

@@ -1,110 +1,149 @@
+/// <summary>Types and functions supporting htmx attributes in Giraffe View Engine</summary>
 module Giraffe.ViewEngine.Htmx
 
-/// Serialize a list of key/value pairs to JSON (very rudimentary)
+/// <summary>Valid values for the <tt>hx-encoding</tt> attribute</summary>
-let private toJson (kvps : (string * string) list) =
-    kvps
-    |> List.map (fun kvp -> sprintf "\"%s\": \"%s\"" (fst kvp) ((snd kvp).Replace ("\"", "\\\"")))
-    |> String.concat ", "
-    |> sprintf "{ %s }"
-
-
-/// Valid values for the `hx-encoding` attribute
 [<RequireQualifiedAccess>]
 module HxEncoding =
     
-    /// A standard HTTP form
+    /// <summary>A standard HTTP form</summary>
     let Form = "application/x-www-form-urlencoded"
     
-    /// A multipart form (used for file uploads)
+    /// <summary>A multipart form (used for file uploads)</summary>
     let MultipartForm = "multipart/form-data"
 
 
-/// The events recognized by htmx
+/// <summary>The events recognized by htmx</summary>
 [<Struct>]
 type HxEvent =
-    /// Send this event to an element to abort a request
+    
+    /// <summary>Send this event to an element to abort a request</summary>
     | Abort
-    /// Triggered after an AJAX request has completed processing a successful response
+    
+    /// <summary>Triggered after an AJAX request has completed processing a successful response</summary>
     | AfterOnLoad
-    /// Triggered after htmx has initialized a node
+    
+    /// <summary>Triggered after htmx has initialized a node</summary>
     | AfterProcessNode
-    /// Triggered after an AJAX request has completed
+    
+    /// <summary>Triggered after an AJAX request has completed</summary>
     | AfterRequest
-    /// Triggered after the DOM has settled
+    
+    /// <summary>Triggered after the DOM has settled</summary>
     | AfterSettle
-    /// Triggered after new content has been swapped in
+    
+    /// <summary>Triggered after new content has been swapped in</summary>
     | AfterSwap
-    /// Triggered before htmx disables an element or removes it from the DOM
+    
+    /// <summary>Triggered before htmx disables an element or removes it from the DOM</summary>
     | BeforeCleanupElement
-    /// Triggered before any response processing occurs
+    
+    /// <summary>Triggered before any response processing occurs</summary>
     | BeforeOnLoad
-    /// Triggered before htmx initializes a node
+    
+    /// <summary>Triggered before htmx initializes a node</summary>
     | BeforeProcessNode
-    /// Triggered before an AJAX request is made
+    
+    /// <summary>Triggered before an AJAX request is made</summary>
     | BeforeRequest
-    /// Triggered before a swap is done, allows you to configure the swap
+    
+    /// <summary>Triggered before a swap is done, allows you to configure the swap</summary>
     | BeforeSwap
-    /// Triggered just before an ajax request is sent
+    
+    /// <summary>Triggered just before an ajax request is sent</summary>
     | BeforeSend
-    /// Triggered before the request, allows you to customize parameters, headers
+    
+    /// <summary>Triggered before the request, allows you to customize parameters, headers</summary>
     | ConfigRequest
+    
+    /// <summary>
     /// Triggered after a trigger occurs on an element, allows you to cancel (or delay) issuing the AJAX request
+    /// </summary>
     | Confirm
-    /// Triggered on an error during cache writing
+    
+    /// <summary>Triggered on an error during cache writing</summary>
     | HistoryCacheError
-    /// Triggered on a cache miss in the history subsystem
+    
+    /// <summary>Triggered on a cache miss in the history subsystem</summary>
     | HistoryCacheMiss
-    /// Triggered on a unsuccessful remote retrieval
+    
+    /// <summary>Triggered on a unsuccessful remote retrieval</summary>
     | HistoryCacheMissError
-    /// Triggered on a successful remote retrieval
+    
+    /// <summary>Triggered on a successful remote retrieval</summary>
     | HistoryCacheMissLoad
-    /// Triggered when htmx handles a history restoration action
+    
+    /// <summary>Triggered when htmx handles a history restoration action</summary>
     | HistoryRestore
-    /// Triggered before content is saved to the history cache
+    
+    /// <summary>Triggered before content is saved to the history cache</summary>
     | BeforeHistorySave
-    /// Triggered when new content is added to the DOM
+    
+    /// <summary>Triggered when new content is added to the DOM</summary>
     | Load
+    
+    /// <summary>
     /// Triggered when an element refers to a SSE event in its trigger, but no parent SSE source has been defined
+    /// </summary>
     | NoSseSourceError
-    /// Triggered when an exception occurs during the onLoad handling in htmx
+    
+    /// <summary>Triggered when an exception occurs during the onLoad handling in htmx</summary>
     | OnLoadError
-    /// Triggered after an out of band element as been swapped in
+    
+    /// <summary>Triggered after an out of band element as been swapped in</summary>
     | OobAfterSwap
-    /// Triggered before an out of band element swap is done, allows you to configure the swap
+    
+    /// <summary>Triggered before an out of band element swap is done, allows you to configure the swap</summary>
     | OobBeforeSwap
-    /// Triggered when an out of band element does not have a matching ID in the current DOM
+    
+    /// <summary>Triggered when an out of band element does not have a matching ID in the current DOM</summary>
     | OobErrorNoTarget
-    /// Triggered after a prompt is shown
+    
+    /// <summary>Triggered after a prompt is shown</summary>
     | Prompt
-    /// Triggered after an url is pushed into history
+    
+    /// <summary>Triggered after an url is pushed into history</summary>
     | PushedIntoHistory
-    /// Triggered when an HTTP response error (non-200 or 300 response code) occurs
+    
+    /// <summary>Triggered when an HTTP response error (non-200 or 300 response code) occurs</summary>
     | ResponseError
-    /// Triggered when a network error prevents an HTTP request from happening
+    
+    /// <summary>Triggered when a network error prevents an HTTP request from happening</summary>
     | SendError
-    /// Triggered when an error occurs with a SSE source
+    
+    /// <summary>Triggered when an error occurs with a SSE source</summary>
     | SseError
-    /// Triggered when a SSE source is opened
+    
+    /// <summary>Triggered when a SSE source is opened</summary>
     | SseOpen
-    /// Triggered when an error occurs during the swap phase
+    
+    /// <summary>Triggered when an error occurs during the swap phase</summary>
     | SwapError
-    /// Triggered when an invalid target is specified
+    
+    /// <summary>Triggered when an invalid target is specified</summary>
     | TargetError
-    /// Triggered when a request timeout occurs
+    
+    /// <summary>Triggered when a request timeout occurs</summary>
     | Timeout
-    /// Triggered before an element is validated
+    
+    /// <summary>Triggered before an element is validated</summary>
     | ValidationValidate
-    /// Triggered when an element fails validation
+    
+    /// <summary>Triggered when an element fails validation</summary>
     | ValidationFailed
-    /// Triggered when a request is halted due to validation errors
+    
+    /// <summary>Triggered when a request is halted due to validation errors</summary>
     | ValidationHalted
-    /// Triggered when an ajax request aborts
+    
+    /// <summary>Triggered when an ajax request aborts</summary>
     | XhrAbort
-    /// Triggered when an ajax request ends
+    
+    /// <summary>Triggered when an ajax request ends</summary>
     | XhrLoadEnd
-    /// Triggered when an ajax request starts
+    
+    /// <summary>Triggered when an ajax request starts</summary>
     | XhrLoadStart
-    /// Triggered periodically during an ajax request that supports progress events
+    
+    /// <summary>Triggered periodically during an ajax request that supports progress events</summary>
     | XhrProgress
     
     /// The htmx event name (fst) and kebab-case name (snd, for use with hx-on)
@@ -153,60 +192,77 @@ type HxEvent =
         XhrProgress, ("xhr:progress", "xhr:progress")
     ]
     
-    /// The htmx event name 
+    /// <summary>The htmx event name</summary> 
     override this.ToString() = fst HxEvent.Values[this]
     
-    /// The hx-on variant of the htmx event name
+    /// <summary>The <tt>hx-on</tt> variant of the htmx event name</summary>
     member this.ToHxOnString() = snd HxEvent.Values[this]
 
 
-/// Helper to create the `hx-headers` attribute
+/// <summary>Helper to create the <tt>hx-headers</tt> attribute</summary>
 [<RequireQualifiedAccess>]
 module HxHeaders =
     
-    /// Create headers from a list of key/value pairs
+    /// <summary>Create headers from a list of key/value pairs</summary>
-    let From = toJson
+    let From = Giraffe.Htmx.Common.toJson
 
 
-/// Values / helpers for the `hx-params` attribute
+/// <summary>Values / helpers for the <tt>hx-params</tt> attribute</summary>
 [<RequireQualifiedAccess>]
 module HxParams =
     
-    /// Include all parameters
+    /// <summary>Include all parameters</summary>
     let All = "*"
     
-    /// Include no parameters
+    /// <summary>Include no parameters</summary>
     let None = "none"
     
-    /// Include the specified parameters
+    /// <summary>Include the specified parameters</summary>
-    let With   fields = match fields with [] -> "" | _ -> fields |> List.reduce (fun acc it -> $"{acc},{it}")
+    /// <param name="fields">One or more fields to include in the request</param>
+    /// <returns>The list of fields for the <tt>hx-params</tt> attribute value</returns>
+    let With fields =
+        match fields with [] -> "" | _ -> fields |> List.reduce (fun acc it -> $"{acc},{it}")
     
-    /// Exclude the specified parameters
+    /// <summary>Exclude the specified parameters</summary>
-    let Except fields = With fields |> sprintf "not %s"
+    /// <param name="fields">One or more fields to exclude from the request</param>
+    /// <returns>The list of fields for the <tt>hx-params</tt> attribute value prefixed with "not"</returns>
+    let Except fields =
+        With fields |> sprintf "not %s"
 
 
-/// Helpers to define `hx-request` attribute values
+/// <summary>Helpers to define <tt>hx-request</tt> attribute values</summary>
 [<RequireQualifiedAccess>]
 module HxRequest =
     
-    /// Convert a boolean to its lowercase string equivalent
+    open Giraffe.Htmx.Common
-    let private toLowerBool (it : bool) =
-        (string it).ToLowerInvariant ()
     
-    /// Configure the request with various options
+    /// <summary>Configure the request with various options</summary>
+    /// <param name="opts">The options to configure</param>
+    /// <returns>A string with the configured options</returns>
     let Configure (opts: string list) =
         opts
         |> String.concat ", "
         |> sprintf "{ %s }"
     
-    /// Set a timeout (in milliseconds)
+    /// <summary>Set a timeout (in milliseconds)</summary>
-    let Timeout (ms : int) = $"\"timeout\": {ms}"
+    /// <param name="ms">The milliseconds for the request timeout</param>
+    /// <returns>A string with the configured request timeout</returns>
+    let Timeout (ms: int) =
+        $"\"timeout\": {ms}"
     
-    /// Include or exclude credentials from the request
+    /// <summary>Include or exclude credentials from the request</summary>
-    let Credentials = toLowerBool >> sprintf "\"credentials\": %s"
+    /// <param name="send"><tt>true</tt> if credentials should be sent, <tt>false</tt> if not</param>
+    /// <returns>A string with the configured credential options</returns>
+    let Credentials send =
+        (toLowerBool >> sprintf "\"credentials\": %s") send
     
-    /// Exclude or include headers from the request
+    /// <summary>Exclude or include headers from the request</summary>
-    let NoHeaders = toLowerBool >> sprintf "\"noHeaders\": %s"
+    /// <param name="exclude">
+    /// <tt>true</tt> if no headers should be sent; <tt>false</tt> if headers should be sent
+    /// </param>
+    /// <returns>A string with the configured header options</returns>
+    let NoHeaders exclude =
+        (toLowerBool >> sprintf "\"noHeaders\": %s") exclude
 
 
 /// Helpers for the `hx-trigger` attribute
@@ -310,45 +366,69 @@ module HxTrigger =
     let QueueNone = Queue "none"
 
 
-/// Helper to create the `hx-vals` attribute
+/// <summary>Helper to create the `hx-vals` attribute</summary>
 [<RequireQualifiedAccess>]
 module HxVals =
     
-    /// Create values from a list of key/value pairs
+    /// <summary>Create values from a list of key/value pairs</summary>
-    let From = toJson
+    let From = Giraffe.Htmx.Common.toJson
 
-/// Attributes and flags for htmx
+
+/// <summary>Attributes and flags for htmx</summary>
 [<AutoOpen>]
 module HtmxAttrs =
     
-    /// Progressively enhances anchors and forms to use AJAX requests (use `_hxNoBoost` to set to false)
+    /// <summary>Progressively enhances anchors and forms to use AJAX requests</summary>
+    /// <remarks>Use <tt>_hxNoBoost</tt> to set to false</remarks>
     let _hxBoost = attr "hx-boost" "true"
     
-    /// Shows a confirm() dialog before issuing a request
+    /// <summary>Shows a <tt>confirm()</tt> dialog before issuing a request</summary>
-    let _hxConfirm    = attr "hx-confirm"
+    /// <param name="prompt">The prompt to present to the user when seeking their confirmation</param>
+    /// <returns>A configured <tt>hx-confirm</tt> attribute</returns>
+    let _hxConfirm prompt =
+        attr "hx-confirm" prompt
     
-    /// Issues a DELETE to the specified URL
+    /// <summary>Issues a <tt>DELETE</tt> to the specified URL</summary>
-    let _hxDelete     = attr "hx-delete"
+    /// <param name="url">The URL to which the <tt>DELETE</tt> request should be sent</param>
+    /// <returns>A configured <tt>hx-delete</tt> attribute</returns>
+    let _hxDelete url =
+        attr "hx-delete" url
     
-    /// Disables htmx processing for the given node and any children nodes
+    /// <summary>Disables htmx processing for the given node and any children nodes</summary>
     let _hxDisable = flag "hx-disable"
     
-    /// Specifies elements that should be disabled when an htmx request is in flight
+    /// <summary>Specifies elements that should be disabled when an htmx request is in flight</summary>
-    let _hxDisabledElt = attr "hx-disabled-elt"
+    /// <param name="elt">The element to disable when an htmx request is in flight</param>
+    /// <returns>A configured <tt>hx-disabled-elt</tt> attribute</returns>
+    let _hxDisabledElt elt =
+        attr "hx-disabled-elt" elt
 
-    /// Disinherit all ("*") or specific htmx attributes
+    /// <summary>Disinherit all ("*") or specific htmx attributes</summary>
-    let _hxDisinherit = attr "hx-disinherit"
+    /// <param name="hxAttrs">The htmx attributes to disinherit (should start with "hx-")</param>
+    /// <returns>A configured <tt>hx-disinherit</tt> attribute</returns>
+    let _hxDisinherit hxAttrs =
+        attr "hx-disinherit" hxAttrs
     
-    /// Changes the request encoding type
+    /// <summary>Changes the request encoding type</summary>
-    let _hxEncoding   = attr "hx-encoding"
+    /// <param name="enc">The encoding type (use <tt>HxEncoding</tt> constants)</param>
+    /// <returns>A configured <tt>hx-encoding</tt> attribute</returns>
+    let _hxEncoding enc =
+        attr "hx-encoding" enc
     
-    /// Extensions to use for this element
+    /// <summary>Extensions to use for this element</summary>
-    let _hxExt        = attr "hx-ext"
+    /// <param name="exts">A list of extensions to apply to this element</param>
+    /// <returns>A configured <tt>hx-ext</tt> attribute</returns>
+    let _hxExt exts =
+        attr "hx-ext" exts
     
-    /// Issues a GET to the specified URL
+    /// <summary>Issues a <tt>GET</tt> to the specified URL</summary>
-    let _hxGet        = attr "hx-get"
+    /// <param name="url">The URL to which the <tt>GET</tt> request should be sent</param>
+    /// <returns>A configured <tt>hx-get</tt> attribute</returns>
+    let _hxGet url =
+        attr "hx-get" url
     
-    /// Adds to the headers that will be submitted with the request
+    /// <summary>Adds to the headers that will be submitted with the request</summary>
+    [<System.Obsolete "Convert this parameter">]
     let _hxHeaders    = attr "hx-headers"
     
     /// Set to "false" to prevent pages with sensitive information from being stored in the history cache
@@ -407,9 +487,6 @@ module HtmxAttrs =
     /// Selects a subset of an out-of-band server response
     let _hxSelectOob  = attr "hx-select-oob"
     
-    /// Establishes and listens to Server Sent Event (SSE) sources for events
-    let _hxSse        = attr "hx-sse"
-    
     /// Controls how the response content is swapped into the DOM (e.g. 'outerHTML' or 'beforeEnd')
     let _hxSwap       = attr "hx-swap"
     
@@ -435,23 +512,26 @@ module HtmxAttrs =
     /// Adds to the parameters that will be submitted with the request
     let _hxVals       = attr "hx-vals"
     
-    /// Establishes a WebSocket or sends information to one
+    /// The name of the message to swap into the DOM.
-    let _hxWs         = attr "hx-ws"
+    let _sseSwap      = attr "sse-swap"
+
+    /// The URL of the SSE server.
+    let _sseConnect   = attr "sse-connect"
 
 
-/// Script tags to pull htmx into an web page
+/// Script tags to pull htmx into a web page
 module Script =
   
     /// Script tag to load the minified version from unpkg.com
     let minified =
-        script [ _src         "https://unpkg.com/htmx.org@2.0.0-alpha2"
+        script [ _src         "https://unpkg.com/htmx.org@2.0.4"
-                 _integrity   "sha384-291pOdLqD0RmU6d5pyz/xmHmZZPhEv465X4AJDWvc8n0KrWrD65qaf2fk0xmsrJe"
+                 _integrity   "sha384-HGfztofotfshcF7+8n44JQL2oJmowVChPTg48S+jvZoztPfvwD79OC/LTtG6dMp+"
                  _crossorigin "anonymous" ] []
 
     /// Script tag to load the unminified version from unpkg.com
     let unminified =
-        script [ _src         "https://unpkg.com/htmx.org@2.0.0-alpha2/dist/htmx.js"
+        script [ _src         "https://unpkg.com/htmx.org@2.0.4/dist/htmx.js"
-                 _integrity   "sha384-4Owd2qj8qFNBZ8QiR2ItYnNuMGgpOxaDT1uuRJXziuB1lvvKGYA/Lxy/oVM6q3h1"
+                 _integrity   "sha384-oeUn82QNXPuVkGCkcrInrS1twIxKhkZiFfr2TdiuObZ3n3yIeMiqcRzkIcguaof1"
                  _crossorigin "anonymous" ] []
 
 

src/ViewEngine.Htmx/README.md

@@ -2,13 +2,13 @@
 
 This package enables [htmx](https://htmx.org) support within the [Giraffe](https://giraffe.wiki) view engine.
 
-**htmx version: 2.0.0-alpha2**
+**htmx version: 2.0.4**
 
-_Note that this is an ALPHA release of htmx 2.0; see [the migration guide](https://v2-0v2-0.htmx.org/migration-guide-htmx-1/) for changes_
+_Upgrading from v1.x: see [the migration guide](https://htmx.org/migration-guide-htmx-1/) for changes_
 
 ### Setup
 
-1. Install the package (must use `--Prelease` flag).
+1. Install the package.
 2. Prior to using the attribute or support modules, `open Giraffe.ViewEngine.Htmx`.
 
 ### Use

src/pack.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+dotnet pack Common/Giraffe.Htmx.Common.fsproj -c Release
+dotnet pack Htmx/Giraffe.Htmx.fsproj -c Release
+dotnet pack ViewEngine.Htmx/Giraffe.ViewEngine.Htmx.fsproj -c Release
+cp Common/bin/Release/Giraffe.Htmx.Common.*.nupkg .
+cp Htmx/bin/Release/Giraffe.Htmx.*.nupkg .
+cp ViewEngine.Htmx/bin/Release/Giraffe.ViewEngine.Htmx.*.nupkg .