Update package READMEs

- Bump library version
- Bump htmx script version
- Add hx-replace-url / HX-Replace-Url
- Add hx-select-oob
- Change hx-push-url to accept a string
- Add HX-Push-Url, obsolete HX-Push
- Implement HX-Reswap header
- Rework project structure to add common project

README.md

@@ -63,6 +63,8 @@ Some attributes have known values, such as `hx-trigger` and `hx-swap`; for these
       ]
 ```
 
+If you want to load htmx from unpkg, `Htmx.Script.minified` or `Htmx.Script.unminified` can be used to load the script in your HTML trees.
+
 ## Feedback / Help
 
 The author hangs out in the #htmx-general channel of the [htmx Discord server](https://htmx.org/discord) and the #web channel of the [F# Software Foundation's Slack server](https://fsharp.org/guides/slack/).

src/Common.Tests/Giraffe.Htmx.Common.Tests.fsproj

@@ -0,0 +1,30 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <IsPackable>false</IsPackable>
+    <GenerateProgramFile>false</GenerateProgramFile>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="Tests.fs" />
+    <Compile Include="Program.fs" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
+    <PackageReference Include="xunit" Version="2.4.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="coverlet.collector" Version="3.1.0">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Common\Giraffe.Htmx.Common.fsproj" />
+  </ItemGroup>
+
+</Project>

src/Common.Tests/Program.fs

@@ -0,0 +1 @@
+module Program = let [<EntryPoint>] main _ = 0

src/Common.Tests/Tests.fs

@@ -0,0 +1,35 @@
+module Tests
+
+open Giraffe.Htmx
+open Xunit
+
+/// Tests for the HxSwap module
+module Swap =
+
+    [<Fact>]
+    let ``InnerHtml is correct`` () =
+        Assert.Equal ("innerHTML", HxSwap.InnerHtml)
+
+    [<Fact>]
+    let ``OuterHtml is correct`` () =
+        Assert.Equal ("outerHTML", HxSwap.OuterHtml)
+
+    [<Fact>]
+    let ``BeforeBegin is correct`` () =
+        Assert.Equal ("beforebegin", HxSwap.BeforeBegin)
+
+    [<Fact>]
+    let ``BeforeEnd is correct`` () =
+        Assert.Equal ("beforeend", HxSwap.BeforeEnd)
+
+    [<Fact>]
+    let ``AfterBegin is correct`` () =
+        Assert.Equal ("afterbegin", HxSwap.AfterBegin)
+
+    [<Fact>]
+    let ``AfterEnd is correct`` () =
+        Assert.Equal ("afterend", HxSwap.AfterEnd)
+
+    [<Fact>]
+    let ``None is correct`` () =
+        Assert.Equal ("none", HxSwap.None)

src/Common/Common.fs

@@ -0,0 +1,28 @@
+/// Common definitions shared between attribute values and response headers
+[<AutoOpen>]
+module Giraffe.Htmx.Common
+
+/// Valid values for the `hx-swap` attribute / `HX-Reswap` header (may be combined with swap/settle/scroll/show config)
+[<RequireQualifiedAccess>]
+module HxSwap =
+    
+    /// The default, replace the inner html of the target element
+    let InnerHtml = "innerHTML"
+    
+    /// Replace the entire target element with the response
+    let OuterHtml = "outerHTML"
+    
+    /// Insert the response before the target element
+    let BeforeBegin = "beforebegin"
+    
+    /// Insert the response before the first child of the target element
+    let AfterBegin = "afterbegin"
+    
+    /// Insert the response after the last child of the target element
+    let BeforeEnd = "beforeend"
+    
+    /// Insert the response after the target element
+    let AfterEnd = "afterend"
+    
+    /// Does not append content from response (out of band items will still be processed).
+    let None = "none"

src/Common/Giraffe.Htmx.Common.fsproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="Common.fs" />
+  </ItemGroup>
+
+</Project>

src/Directory.Build.props

@@ -1,8 +1,9 @@
 <?xml version="1.0" encoding="utf-8" standalone="no"?>
 <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
     <PropertyGroup>
-        <VersionPrefix>0.9.1</VersionPrefix>
+        <TargetFramework>net6.0</TargetFramework>
-        <PackageReleaseNotes>Initial NuGet release</PackageReleaseNotes>
+        <VersionPrefix>1.8.0</VersionPrefix>
+        <PackageReleaseNotes>Support new attributes/headers in htmx 1.8.0</PackageReleaseNotes>
         <Authors>danieljsummers</Authors>
         <Company>Bit Badger Solutions</Company>
         <PackageProjectUrl>https://github.com/bit-badger/Giraffe.Htmx</PackageProjectUrl>

src/Giraffe.Htmx.sln

@@ -0,0 +1,52 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.30114.105
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Giraffe.Htmx", "Htmx\Giraffe.Htmx.fsproj", "{8AB3085C-5236-485A-8565-A09106E72E1E}"
+EndProject
+Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Giraffe.Htmx.Tests", "Htmx.Tests\Giraffe.Htmx.Tests.fsproj", "{D7CDD578-7A6F-4EF6-846A-80A55037E049}"
+EndProject
+Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Giraffe.ViewEngine.Htmx", "ViewEngine.Htmx\Giraffe.ViewEngine.Htmx.fsproj", "{F718B3C1-EE01-4F04-ABCE-BF2AE700FDA9}"
+EndProject
+Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Giraffe.ViewEngine.Htmx.Tests", "ViewEngine.Htmx.Tests\Giraffe.ViewEngine.Htmx.Tests.fsproj", "{F21C28CE-1F18-4CB0-B2F7-10DABE84FB78}"
+EndProject
+Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Giraffe.Htmx.Common", "Common\Giraffe.Htmx.Common.fsproj", "{75D66845-F93A-4463-AD29-A8B16E4D4BA9}"
+EndProject
+Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Giraffe.Htmx.Common.Tests", "Common.Tests\Giraffe.Htmx.Common.Tests.fsproj", "{E261A653-68D5-4D7B-99A4-F09282B50F8A}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{8AB3085C-5236-485A-8565-A09106E72E1E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{8AB3085C-5236-485A-8565-A09106E72E1E}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{8AB3085C-5236-485A-8565-A09106E72E1E}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{8AB3085C-5236-485A-8565-A09106E72E1E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D7CDD578-7A6F-4EF6-846A-80A55037E049}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D7CDD578-7A6F-4EF6-846A-80A55037E049}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D7CDD578-7A6F-4EF6-846A-80A55037E049}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D7CDD578-7A6F-4EF6-846A-80A55037E049}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F718B3C1-EE01-4F04-ABCE-BF2AE700FDA9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F718B3C1-EE01-4F04-ABCE-BF2AE700FDA9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F718B3C1-EE01-4F04-ABCE-BF2AE700FDA9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F718B3C1-EE01-4F04-ABCE-BF2AE700FDA9}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F21C28CE-1F18-4CB0-B2F7-10DABE84FB78}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F21C28CE-1F18-4CB0-B2F7-10DABE84FB78}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F21C28CE-1F18-4CB0-B2F7-10DABE84FB78}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F21C28CE-1F18-4CB0-B2F7-10DABE84FB78}.Release|Any CPU.Build.0 = Release|Any CPU
+		{75D66845-F93A-4463-AD29-A8B16E4D4BA9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{75D66845-F93A-4463-AD29-A8B16E4D4BA9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{75D66845-F93A-4463-AD29-A8B16E4D4BA9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{75D66845-F93A-4463-AD29-A8B16E4D4BA9}.Release|Any CPU.Build.0 = Release|Any CPU
+		{E261A653-68D5-4D7B-99A4-F09282B50F8A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{E261A653-68D5-4D7B-99A4-F09282B50F8A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{E261A653-68D5-4D7B-99A4-F09282B50F8A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{E261A653-68D5-4D7B-99A4-F09282B50F8A}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal

src/Htmx.Tests/Giraffe.Htmx.Tests.fsproj

@@ -1,8 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
-
     <IsPackable>false</IsPackable>
     <GenerateProgramFile>false</GenerateProgramFile>
   </PropertyGroup>

src/Htmx.Tests/Tests.fs

@@ -207,14 +207,25 @@ module HandlerTests =
     let next (ctx : HttpContext) = Task.FromResult (Some ctx)
     
     [<Fact>]
-  let ``withHxPush succeeds`` () =
+    let ``withHxPushUrl succeeds`` () =
         let ctx = Substitute.For<HttpContext> ()
         let dic = HeaderDictionary ()
         ctx.Response.Headers.ReturnsForAnyArgs dic |> ignore
         task {
-      let! _ = withHxPush "/a-new-url" next ctx
+            let! _ = withHxPushUrl "/a-new-url" next ctx
-      Assert.True (dic.ContainsKey "HX-Push")
+            Assert.True (dic.ContainsKey "HX-Push-Url")
-      Assert.Equal ("/a-new-url", dic.["HX-Push"].[0])
+            Assert.Equal ("/a-new-url", dic["HX-Push-Url"][0])
+        }
+
+    [<Fact>]
+    let ``withHxNoPushUrl succeeds`` () =
+        let ctx = Substitute.For<HttpContext> ()
+        let dic = HeaderDictionary ()
+        ctx.Response.Headers.ReturnsForAnyArgs dic |> ignore
+        task {
+            let! _ = withHxNoPushUrl next ctx
+            Assert.True (dic.ContainsKey "HX-Push-Url")
+            Assert.Equal ("false", dic["HX-Push-Url"][0])
         }
 
     [<Fact>]
@@ -225,7 +236,7 @@ module HandlerTests =
         task {
             let! _ = withHxRedirect "/somewhere-else" next ctx
             Assert.True (dic.ContainsKey "HX-Redirect")
-      Assert.Equal ("/somewhere-else", dic.["HX-Redirect"].[0])
+            Assert.Equal ("/somewhere-else", dic["HX-Redirect"][0])
         }
 
     [<Fact>]
@@ -236,7 +247,7 @@ module HandlerTests =
         task {
             let! _ = withHxRefresh true next ctx
             Assert.True (dic.ContainsKey "HX-Refresh")
-      Assert.Equal ("true", dic.["HX-Refresh"].[0])
+            Assert.Equal ("true", dic["HX-Refresh"][0])
         }
 
     [<Fact>]
@@ -247,7 +258,51 @@ module HandlerTests =
         task {
             let! _ = withHxRefresh false next ctx
             Assert.True (dic.ContainsKey "HX-Refresh")
-      Assert.Equal ("false", dic.["HX-Refresh"].[0])
+            Assert.Equal ("false", dic["HX-Refresh"][0])
+        }
+
+    [<Fact>]
+    let ``withHxReplaceUrl succeeds`` () =
+        let ctx = Substitute.For<HttpContext> ()
+        let dic = HeaderDictionary ()
+        ctx.Response.Headers.ReturnsForAnyArgs dic |> ignore
+        task {
+            let! _ = withHxReplaceUrl "/a-substitute-url" next ctx
+            Assert.True (dic.ContainsKey "HX-Replace-Url")
+            Assert.Equal ("/a-substitute-url", dic["HX-Replace-Url"][0])
+        }
+
+    [<Fact>]
+    let ``withHxNoReplaceUrl succeeds`` () =
+        let ctx = Substitute.For<HttpContext> ()
+        let dic = HeaderDictionary ()
+        ctx.Response.Headers.ReturnsForAnyArgs dic |> ignore
+        task {
+            let! _ = withHxNoReplaceUrl next ctx
+            Assert.True (dic.ContainsKey "HX-Replace-Url")
+            Assert.Equal ("false", dic["HX-Replace-Url"][0])
+        }
+
+    [<Fact>]
+    let ``withHxReswap succeeds`` () =
+        let ctx = Substitute.For<HttpContext> ()
+        let dic = HeaderDictionary ()
+        ctx.Response.Headers.ReturnsForAnyArgs dic |> ignore
+        task {
+            let! _ = withHxReswap HxSwap.BeforeEnd next ctx
+            Assert.True (dic.ContainsKey "HX-Reswap")
+            Assert.Equal (HxSwap.BeforeEnd, dic["HX-Reswap"][0])
+        }
+      
+    [<Fact>]
+    let ``withHxRetarget succeeds`` () =
+        let ctx = Substitute.For<HttpContext> ()
+        let dic = HeaderDictionary ()
+        ctx.Response.Headers.ReturnsForAnyArgs dic |> ignore
+        task {
+            let! _ = withHxRetarget "#somewhereElse" next ctx
+            Assert.True (dic.ContainsKey "HX-Retarget")
+            Assert.Equal ("#somewhereElse", dic["HX-Retarget"][0])
         }
       
     [<Fact>]
@@ -258,7 +313,7 @@ module HandlerTests =
         task {
             let! _ = withHxTrigger "doSomething" next ctx
             Assert.True (dic.ContainsKey "HX-Trigger")
-      Assert.Equal ("doSomething", dic.["HX-Trigger"].[0])
+            Assert.Equal ("doSomething", dic["HX-Trigger"][0])
         }
 
     [<Fact>]
@@ -269,7 +324,7 @@ module HandlerTests =
         task {
             let! _ = withHxTriggerMany [ "blah", "foo"; "bleh", "bar" ] next ctx
             Assert.True (dic.ContainsKey "HX-Trigger")
-      Assert.Equal ("""{ "blah": "foo", "bleh": "bar" }""", dic.["HX-Trigger"].[0])
+            Assert.Equal ("""{ "blah": "foo", "bleh": "bar" }""", dic["HX-Trigger"][0])
         }
 
     [<Fact>]
@@ -280,7 +335,7 @@ module HandlerTests =
         task {
             let! _ = withHxTriggerAfterSettle "byTheWay" next ctx
             Assert.True (dic.ContainsKey "HX-Trigger-After-Settle")
-      Assert.Equal ("byTheWay", dic.["HX-Trigger-After-Settle"].[0])
+            Assert.Equal ("byTheWay", dic["HX-Trigger-After-Settle"][0])
         }
 
     [<Fact>]
@@ -291,7 +346,7 @@ module HandlerTests =
         task {
             let! _ = withHxTriggerManyAfterSettle [ "oof", "ouch"; "hmm", "uh" ] next ctx
             Assert.True (dic.ContainsKey "HX-Trigger-After-Settle")
-      Assert.Equal ("""{ "oof": "ouch", "hmm": "uh" }""", dic.["HX-Trigger-After-Settle"].[0])
+            Assert.Equal ("""{ "oof": "ouch", "hmm": "uh" }""", dic["HX-Trigger-After-Settle"][0])
         }
 
     [<Fact>]
@@ -302,7 +357,7 @@ module HandlerTests =
         task {
             let! _ = withHxTriggerAfterSwap "justASec" next ctx
             Assert.True (dic.ContainsKey "HX-Trigger-After-Swap")
-      Assert.Equal ("justASec", dic.["HX-Trigger-After-Swap"].[0])
+            Assert.Equal ("justASec", dic["HX-Trigger-After-Swap"][0])
         }
 
     [<Fact>]
@@ -313,6 +368,5 @@ module HandlerTests =
         task {
             let! _ = withHxTriggerManyAfterSwap [ "this", "1"; "that", "2" ] next ctx
             Assert.True (dic.ContainsKey "HX-Trigger-After-Swap")
-      Assert.Equal ("""{ "this": "1", "that": "2" }""", dic.["HX-Trigger-After-Swap"].[0])
+            Assert.Equal ("""{ "this": "1", "that": "2" }""", dic["HX-Trigger-After-Swap"][0])
         }
-

src/Htmx/Giraffe.Htmx.fsproj

@@ -1,17 +1,22 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Description>htmx header extensions and helpers for Giraffe</Description>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <Compile Include="Htmx.fs" />
+    <None Include="README.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup>
     <PackageReference Include="Giraffe" Version="5.0.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\Common\Giraffe.Htmx.Common.fsproj" />
+  </ItemGroup>
+
 </Project>

src/Htmx/Htmx.fs

@@ -6,7 +6,7 @@ open System
 
 /// Determine if the given header is present
 let private hdr (headers : IHeaderDictionary) hdr =
-  match headers.[hdr] with it when it = StringValues.Empty -> None | it -> Some it.[0]
+    match headers[hdr] with it when it = StringValues.Empty -> None | it -> Some it[0]
 
 /// Extensions to the header dictionary
 type IHeaderDictionary with
@@ -39,10 +39,10 @@ type IHeaderDictionary with
 /// Extensions for the request object
 type HttpRequest with
 
-  /// Whether this request was initiated from HTMX
+    /// Whether this request was initiated from htmx
     member this.IsHtmx with get () = this.Headers.HxRequest |> Option.defaultValue false
 
-  /// Whether this request is an HTMX history-miss refresh request
+    /// Whether this request is an htmx history-miss refresh request
     member this.IsHtmxRefresh with get () =
         this.IsHtmx && (this.Headers.HxHistoryRestoreRequest |> Option.defaultValue false)
 
@@ -62,9 +62,21 @@ module Handlers =
         |> String.concat ", "
         |> sprintf "{ %s }"
 
-  // Pushes a new url into the history stack
+    /// Pushes a new url into the history stack
-  let withHxPush : string -> HttpHandler =
+    let withHxPushUrl : string -> HttpHandler =
-    setHttpHeader "HX-Push"
+        setHttpHeader "HX-Push-Url"
+
+    /// Explicitly do not push a new URL into the history stack
+    let withHxNoPushUrl : HttpHandler =
+        toLowerBool false |> withHxPushUrl
+      
+    /// Pushes a new url into the history stack
+    [<Obsolete "Use withHxPushUrl; HX-Push was replaced by HX-Push-Url in v1.8.0">]
+    let withHxPush = withHxPushUrl
+    
+    /// Explicitly do not push a new URL into the history stack
+    [<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
     let withHxRedirect : string -> HttpHandler =
@@ -74,6 +86,22 @@ module Handlers =
     let withHxRefresh : bool -> HttpHandler =
         toLowerBool >> setHttpHeader "HX-Refresh"
 
+    /// Replaces the current URL in the history stack
+    let withHxReplaceUrl : string -> HttpHandler =
+        setHttpHeader "HX-Replace-Url"
+
+    /// Explicitly do not replace the current URL in the history stack
+    let withHxNoReplaceUrl : HttpHandler =
+        toLowerBool false |> withHxReplaceUrl
+    
+    /// Override the `hx-swap` attribute from the initiating element
+    let withHxReswap : string -> HttpHandler =
+        setHttpHeader "HX-Reswap"
+
+    /// Allows you to override the `hx-target` attribute
+    let withHxRetarget : string -> HttpHandler =
+        setHttpHeader "HX-Retarget"
+
     /// Allows you to trigger a single client side event
     let withHxTrigger : string -> HttpHandler =
         setHttpHeader "HX-Trigger"

src/Htmx/README.md

@@ -0,0 +1,37 @@
+## Giraffe.Htmx
+
+This package enables server-side support for [htmx](https://htmx.org) within [Giraffe](https://giraffe.wiki) and ASP.NET's `HttpContext`.
+
+**htmx version: 1.8.0**
+
+### Setup
+
+1. Install the package.
+2. Prior to using the request header extension properties or the header-setting `HttpHandler`s, `open Giraffe.Htmx`.
+
+### Use
+
+To obtain a request header, using the `IHeaderDictionary` extension properties:
+
+```fsharp
+  let myHandler : HttpHander =
+    fun next ctx ->
+      match ctx.HxPrompt with
+      | Some prompt -> ... // do something with the text the user provided
+      | None -> ... // no text provided
+```
+
+To set a response header:
+
+```fsharp
+  let myHandler : HttpHander =
+    fun next ctx ->
+      // some meaningful work
+      withHxPushUrl "/some/new/url" >=> [other handlers]
+```
+
+The `HxSwap` module has constants to use for the `HX-Reswap` header. These may be extended with settle, show, and other qualifiers; see the htmx documentation for the `hx-swap` attribute for more information.
+
+### Learn
+
+The naming conventions of this library were selected to mirror those provided by htmx. The header properties become `Hx*` on the `ctx.Request.Headers` object, and the response handlers are `withHx*` based on the header being set. The only part that does not line up is `withHxTrigger*` and `withHxTriggerMany`; the former set work with a single string (to trigger a single event with no arguments), while the latter set supports both arguments and multiple events.

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

@@ -1,8 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
-
     <IsPackable>false</IsPackable>
     <GenerateProgramFile>false</GenerateProgramFile>
   </PropertyGroup>

src/ViewEngine.Htmx.Tests/Tests.fs

@@ -15,6 +15,19 @@ module Encoding =
         Assert.Equal ("multipart/form-data", HxEncoding.MultipartForm)
 
 
+/// Tests for the HxHeaders module
+module Headers =
+
+    [<Fact>]
+    let ``From succeeds with an empty list`` () =
+        Assert.Equal ("{  }", HxHeaders.From [])
+
+    [<Fact>]
+    let ``From succeeds and escapes quotes`` () =
+        Assert.Equal ("{ \"test\": \"one two three\", \"again\": \"four \\\"five\\\" six\" }",
+                      HxHeaders.From [ "test", "one two three"; "again", "four \"five\" six" ])
+
+
 /// Tests for the HxParams module
 module Params =
 
@@ -51,36 +64,41 @@ module Params =
         Assert.Equal ("not blue,green", HxParams.Except [ "blue"; "green" ])
 
 
-/// Tests for the HxSwap module
+/// Tests for the HxRequest module
-module Swap =
+module Request =
 
     [<Fact>]
-  let ``InnerHtml is correct`` () =
+    let ``Configure succeeds with an empty list`` () =
-    Assert.Equal ("innerHTML", HxSwap.InnerHtml)
+        Assert.Equal ("{  }", HxRequest.Configure [])
 
     [<Fact>]
-  let ``OuterHtml is correct`` () =
+    let ``Configure succeeds with a non-empty list`` () =
-    Assert.Equal ("outerHTML", HxSwap.OuterHtml)
+        Assert.Equal ("{ \"a\": \"b\", \"c\": \"d\" }", HxRequest.Configure [ "\"a\": \"b\""; "\"c\": \"d\"" ])
 
     [<Fact>]
-  let ``BeforeBegin is correct`` () =
+    let ``Configure succeeds with all known params configured`` () =
-    Assert.Equal ("beforebegin", HxSwap.BeforeBegin)
+        Assert.Equal ("{ \"timeout\": 1000, \"credentials\": false, \"noHeaders\": true }",
+                      HxRequest.Configure [ HxRequest.Timeout 1000; HxRequest.Credentials false; HxRequest.NoHeaders true ])
 
     [<Fact>]
-  let ``BeforeEnd is correct`` () =
+    let ``Timeout succeeds`` () =
-    Assert.Equal ("beforeend", HxSwap.BeforeEnd)
+        Assert.Equal ("\"timeout\": 50", HxRequest.Timeout 50)
 
     [<Fact>]
-  let ``AfterBegin is correct`` () =
+    let ``Credentials succeeds when set to true`` () =
-    Assert.Equal ("afterbegin", HxSwap.AfterBegin)
+        Assert.Equal ("\"credentials\": true", HxRequest.Credentials true)
 
     [<Fact>]
-  let ``AfterEnd is correct`` () =
+    let ``Credentials succeeds when set to false`` () =
-    Assert.Equal ("afterend", HxSwap.AfterEnd)
+        Assert.Equal ("\"credentials\": false", HxRequest.Credentials false)
 
     [<Fact>]
-  let ``None is correct`` () =
+    let ``NoHeaders succeeds when set to true`` () =
-    Assert.Equal ("none", HxSwap.None)
+        Assert.Equal ("\"noHeaders\": true", HxRequest.NoHeaders true)
+
+    [<Fact>]
+    let ``NoHeaders succeeds when set to false`` () =
+        Assert.Equal ("\"noHeaders\": false", HxRequest.NoHeaders false)
 
   
 /// Tests for the HxTrigger module
@@ -94,6 +112,14 @@ module Trigger =
     let ``Load is correct`` () =
         Assert.Equal ("load", HxTrigger.Load)
 
+    [<Fact>]
+    let ``Revealed is correct`` () =
+        Assert.Equal ("revealed", HxTrigger.Revealed)
+
+    [<Fact>]
+    let ``Every succeeds`` () =
+        Assert.Equal ("every 3s", HxTrigger.Every "3s")
+
     [<Fact>]
     let ``Filter.Alt succeeds`` () =
         Assert.Equal ("click[altKey]", HxTrigger.Filter.Alt HxTrigger.Click)
@@ -122,6 +148,147 @@ module Trigger =
     let ``Filter.AltShift succeeds`` () =
         Assert.Equal ("click[altKey&&shiftKey]", HxTrigger.Filter.AltShift HxTrigger.Click)
 
+    [<Fact>]
+    let ``Once succeeds when it is the first modifier`` () =
+        Assert.Equal ("once", HxTrigger.Once "")
+
+    [<Fact>]
+    let ``Once succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click once", HxTrigger.Once "click")
+
+    [<Fact>]
+    let ``Changed succeeds when it is the first modifier`` () =
+        Assert.Equal ("changed", HxTrigger.Changed "")
+
+    [<Fact>]
+    let ``Changed succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click changed", HxTrigger.Changed "click")
+
+    [<Fact>]
+    let ``Delay succeeds when it is the first modifier`` () =
+        Assert.Equal ("delay:1s", HxTrigger.Delay "1s" "")
+
+    [<Fact>]
+    let ``Delay succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click delay:2s", HxTrigger.Delay "2s" "click")
+
+    [<Fact>]
+    let ``Throttle succeeds when it is the first modifier`` () =
+        Assert.Equal ("throttle:4s", HxTrigger.Throttle "4s" "")
+
+    [<Fact>]
+    let ``Throttle succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click throttle:7s", HxTrigger.Throttle "7s" "click")
+
+    [<Fact>]
+    let ``From succeeds when it is the first modifier`` () =
+        Assert.Equal ("from:.nav", HxTrigger.From ".nav" "")
+
+    [<Fact>]
+    let ``From succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click from:#somewhere", HxTrigger.From "#somewhere" "click")
+
+    [<Fact>]
+    let ``FromDocument succeeds when it is the first modifier`` () =
+        Assert.Equal ("from:document", HxTrigger.FromDocument "")
+      
+    [<Fact>]
+    let ``FromDocument succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click from:document", HxTrigger.FromDocument "click")
+
+    [<Fact>]
+    let ``FromWindow succeeds when it is the first modifier`` () =
+        Assert.Equal ("from:window", HxTrigger.FromWindow "")
+
+    [<Fact>]
+    let ``FromWindow succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click from:window", HxTrigger.FromWindow "click")
+
+    [<Fact>]
+    let ``FromClosest succeeds when it is the first modifier`` () =
+        Assert.Equal ("from:closest div", HxTrigger.FromClosest "div" "")
+
+    [<Fact>]
+    let ``FromClosest succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click from:closest p", HxTrigger.FromClosest "p" "click")
+
+    [<Fact>]
+    let ``FromFind succeeds when it is the first modifier`` () =
+        Assert.Equal ("from:find li", HxTrigger.FromFind "li" "")
+
+    [<Fact>]
+    let ``FromFind succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click from:find .spot", HxTrigger.FromFind ".spot" "click")
+
+    [<Fact>]
+    let ``Target succeeds when it is the first modifier`` () =
+        Assert.Equal ("target:main", HxTrigger.Target "main" "")
+
+    [<Fact>]
+    let ``Target succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click target:footer", HxTrigger.Target "footer" "click")
+
+    [<Fact>]
+    let ``Consume succeeds when it is the first modifier`` () =
+        Assert.Equal ("consume", HxTrigger.Consume "")
+
+    [<Fact>]
+    let ``Consume succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click consume", HxTrigger.Consume "click")
+
+    [<Fact>]
+    let ``Queue succeeds when it is the first modifier`` () =
+        Assert.Equal ("queue:abc", HxTrigger.Queue "abc" "")
+
+    [<Fact>]
+    let ``Queue succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click queue:def", HxTrigger.Queue "def" "click")
+
+    [<Fact>]
+    let ``QueueFirst succeeds when it is the first modifier`` () =
+        Assert.Equal ("queue:first", HxTrigger.QueueFirst "")
+
+    [<Fact>]
+    let ``QueueFirst succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click queue:first", HxTrigger.QueueFirst "click")
+
+    [<Fact>]
+    let ``QueueLast succeeds when it is the first modifier`` () =
+        Assert.Equal ("queue:last", HxTrigger.QueueLast "")
+
+    [<Fact>]
+    let ``QueueLast succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click queue:last", HxTrigger.QueueLast "click")
+
+    [<Fact>]
+    let ``QueueAll succeeds when it is the first modifier`` () =
+        Assert.Equal ("queue:all", HxTrigger.QueueAll "")
+
+    [<Fact>]
+    let ``QueueAll succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click queue:all", HxTrigger.QueueAll "click")
+
+    [<Fact>]
+    let ``QueueNone succeeds when it is the first modifier`` () =
+        Assert.Equal ("queue:none", HxTrigger.QueueNone "")
+
+    [<Fact>]
+    let ``QueueNone succeeds when it is not the first modifier`` () =
+        Assert.Equal ("click queue:none", HxTrigger.QueueNone "click")
+
+
+/// Tests for the HxVals module
+module Vals =
+
+    [<Fact>]
+    let ``From succeeds with an empty list`` () =
+        Assert.Equal ("{  }", HxVals.From [])
+
+    [<Fact>]
+    let ``From succeeds and escapes quotes`` () =
+        Assert.Equal ("{ \"test\": \"a \\\"b\\\" c\", \"2\": \"d e f\" }",
+                      HxVals.From [ "test", "a \"b\" c"; "2", "d e f" ])
+
 
 /// Tests for the HtmxAttrs module
 module Attributes =
@@ -145,6 +312,10 @@ module Attributes =
     let ``_hxDisable succeeds`` () =
         p [ _hxDisable ] [] |> shouldRender """<p hx-disable></p>"""
 
+    [<Fact>]
+    let ``_hxDisinherit succeeds`` () =
+        strong [ _hxDisinherit "*" ] [] |> shouldRender """<strong hx-disinherit="*"></strong>"""
+
     [<Fact>]
     let ``_hxEncoding succeeds`` () =
         form [ _hxEncoding "utf-7" ] [] |> shouldRender """<form hx-encoding="utf-7"></form>"""
@@ -200,12 +371,16 @@ module Attributes =
 
     [<Fact>]
     let ``_hxPushUrl succeeds`` () =
-    dl [ _hxPushUrl ] [] |> shouldRender """<dl hx-push-url></dl>"""
+        dl [ _hxPushUrl "/a-b-c" ] [] |> shouldRender """<dl hx-push-url="/a-b-c"></dl>"""
 
     [<Fact>]
     let ``_hxPut succeeds`` () =
         s [ _hxPut "/take-this" ] [] |> shouldRender """<s hx-put="/take-this"></s>"""
 
+    [<Fact>]
+    let ``_hxReplaceUrl succeeds`` () =
+        p [ _hxReplaceUrl "/something-else" ] [] |> shouldRender """<p hx-replace-url="/something-else"></p>"""
+
     [<Fact>]
     let ``_hxRequest succeeds`` () =
         u [ _hxRequest "noHeaders" ] [] |> shouldRender """<u hx-request="noHeaders"></u>"""
@@ -214,6 +389,10 @@ module Attributes =
     let ``_hxSelect succeeds`` () =
         nav [ _hxSelect "#navbar" ] [] |> shouldRender """<nav hx-select="#navbar"></nav>"""
 
+    [<Fact>]
+    let ``_hxSelectOob succeeds`` () =
+        section [ _hxSelectOob "#oob" ] [] |> shouldRender """<section hx-select-oob="#oob"></section>"""
+
     [<Fact>]
     let ``_hxSse succeeds`` () =
         footer [ _hxSse "connect:/my-events" ] [] |> shouldRender """<footer hx-sse="connect:/my-events"></footer>"""
@@ -226,6 +405,10 @@ module Attributes =
     let ``_hxSwapOob succeeds`` () =
         li [ _hxSwapOob "true" ] [] |> shouldRender """<li hx-swap-oob="true"></li>"""
 
+    [<Fact>]
+    let ``_hxSync succeeds`` () =
+        nav [ _hxSync "closest form:abort" ] [] |> shouldRender """<nav hx-sync="closest form:abort"></nav>"""
+
     [<Fact>]
     let ``_hxTarget succeeds`` () =
         header [ _hxTarget "#somewhereElse" ] [] |> shouldRender """<header hx-target="#somewhereElse"></header>"""
@@ -243,3 +426,20 @@ module Attributes =
     let ``_hxWs succeeds`` () =
         ul [ _hxWs "connect:/web-socket" ] [] |> shouldRender """<ul hx-ws="connect:/web-socket"></ul>"""
 
+
+/// Tests for the Script module
+module Script =
+
+    [<Fact>]
+    let ``Script.minified succeeds`` () =
+        let html = RenderView.AsString.htmlNode Script.minified
+        Assert.Equal
+            ("""<script src="https://unpkg.com/htmx.org@1.8.0" integrity="sha384-cZuAZ+ZbwkNRnrKi05G/fjBX+azI9DNOkNYysZ0I/X5ZFgsmMiBXgDZof30F5ofc" crossorigin="anonymous"></script>""",
+             html)
+
+    [<Fact>]
+    let ``Script.unminified succeeds`` () =
+        let html = RenderView.AsString.htmlNode Script.unminified
+        Assert.Equal
+            ("""<script src="https://unpkg.com/htmx.org@1.8.0/dist/htmx.js" integrity="sha384-mrsv860ohrJ5KkqRxwXXj6OIT6sONUxOd+1kvbqW351hQd7JlfFnM0tLetA76GU0" crossorigin="anonymous"></script>""",
+             html)

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

@@ -1,17 +1,22 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Description>Extensions to Giraffe View Engine to support htmx attributes and their values</Description>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <Compile Include="Htmx.fs" />
+    <None Include="README.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup>
     <PackageReference Include="Giraffe.ViewEngine" Version="1.4.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\Common\Giraffe.Htmx.Common.fsproj" />
+  </ItemGroup>
+
 </Project>

src/ViewEngine.Htmx/Htmx.fs

@@ -1,139 +1,294 @@
 module Giraffe.ViewEngine.Htmx
 
+/// Serialize a list of key/value pairs to JSON (very rudimentary)
+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
     let Form          = "application/x-www-form-urlencoded"
+    
     /// A multipart form (used for file uploads)
     let MultipartForm = "multipart/form-data"
 
-// TODO: hx-header helper
+
+/// Helper to create the `hx-headers` attribute
+[<RequireQualifiedAccess>]
+module HxHeaders =
+    
+    /// Create headers from a list of key/value pairs
+    let From = toJson
+
 
 /// Values / helpers for the `hx-params` attribute
 [<RequireQualifiedAccess>]
 module HxParams =
+    
     /// Include all parameters
     let All  = "*"
+    
     /// Include no parameters
     let None = "none"
+    
     /// Include the specified parameters
     let With   fields = match fields with [] -> "" | _ -> fields |> List.reduce (fun acc it -> $"{acc},{it}")
+    
     /// Exclude the specified parameters
     let Except fields = With fields |> sprintf "not %s"
 
-// TODO: hx-request helper
 
-/// Valid values for the `hx-swap` attribute (may be combined with swap/settle/scroll/show config)
+/// Helpers to define `hx-request` attribute values
 [<RequireQualifiedAccess>]
-module HxSwap =
+module HxRequest =
-  /// The default, replace the inner html of the target element
+    
-  let InnerHtml   = "innerHTML"
+    /// Convert a boolean to its lowercase string equivalent
-  /// Replace the entire target element with the response
+    let private toLowerBool (it : bool) =
-  let OuterHtml   = "outerHTML"
+        (string it).ToLowerInvariant ()
-  /// Insert the response before the target element
+    
-  let BeforeBegin = "beforebegin"
+    /// Configure the request with various options
-  /// Insert the response before the first child of the target element
+    let Configure (opts : string list) =
-  let AfterBegin  = "afterbegin"
+        opts
-  /// Insert the response after the last child of the target element
+        |> String.concat ", "
-  let BeforeEnd   = "beforeend"
+        |> sprintf "{ %s }"
-  /// Insert the response after the target element
+    
-  let AfterEnd    = "afterend"
+    /// Set a timeout (in milliseconds)
-  /// Does not append content from response (out of band items will still be processed).
+    let Timeout (ms : int) = $"\"timeout\": {ms}"
-  let None        = "none"
+    
+    /// Include or exclude credentials from the request
+    let Credentials = toLowerBool >> sprintf "\"credentials\": %s"
+    
+    /// Exclude or include headers from the request
+    let NoHeaders = toLowerBool >> sprintf "\"noHeaders\": %s"
+
 
 /// Helpers for the `hx-trigger` attribute
 [<RequireQualifiedAccess>]
 module HxTrigger =
+    
     /// Append a filter to a trigger
     let private appendFilter filter (trigger : string) =
         match trigger.Contains "[" with
         | true ->
             let parts = trigger.Split ('[', ']')
-        $"{parts.[0]}[{parts.[1]}&&{filter}]"
+            $"{parts[0]}[{parts[1]}&&{filter}]"
         | false -> $"{trigger}[{filter}]"
+    
     /// Trigger the event on a click
     let Click = "click"
+    
     /// Trigger the event on page load
     let Load = "load"
+    
+    /// Trigger the event when the item is visible
+    let Revealed = "revealed"
+    
+    /// Trigger this event every [timing declaration]
+    let Every (duration : string) = $"every {duration}"
+    
     /// Helpers for defining filters
     module Filter =
+
         /// Only trigger the event if the `ALT` key is pressed
         let Alt          = appendFilter "altKey"
+        
         /// Only trigger the event if the `CTRL` key is pressed
         let Ctrl         = appendFilter "ctrlKey"
+        
         /// Only trigger the event if the `SHIFT` key is pressed
         let Shift        = appendFilter "shiftKey"
+        
         /// Only trigger the event if `CTRL+ALT` are pressed
         let CtrlAlt      = Ctrl    >> Alt
+        
         /// Only trigger the event if `CTRL+SHIFT` are pressed
         let CtrlShift    = Ctrl    >> Shift
+        
         /// Only trigger the event if `CTRL+ALT+SHIFT` are pressed
         let CtrlAltShift = CtrlAlt >> Shift
+        
         /// Only trigger the event if `ALT+SHIFT` are pressed
         let AltShift     = Alt     >> Shift
     
-  // TODO: more stuff for the hx-trigger helper
+    /// Append a modifier to the current trigger
+    let private appendModifier modifier current =
+        if current = "" then modifier else $"{current} {modifier}"
     
-// TODO: hx-vals helper
+    /// Only trigger once
+    let Once = appendModifier "once"
+    
+    /// Trigger when changed
+    let Changed = appendModifier "changed"
+    
+    /// Delay execution; resets every time the event is seen
+    let Delay = sprintf "delay:%s" >> appendModifier
+    
+    /// Throttle execution; ignore other events, fire when duration passes
+    let Throttle = sprintf "throttle:%s" >> appendModifier
+    
+    /// Trigger this event from a CSS selector
+    let From = sprintf "from:%s" >> appendModifier
+    
+    /// Trigger this event from the `document` object
+    let FromDocument = From "document"
+    
+    /// Trigger this event from the `window` object
+    let FromWindow = From "window"
+    
+    /// Trigger this event from the closest parent CSS selector
+    let FromClosest = sprintf "closest %s" >> From
+    
+    /// Trigger this event from the closest child CSS selector
+    let FromFind = sprintf "find %s" >> From
+    
+    /// Target the given CSS selector with the results of this event
+    let Target = sprintf "target:%s" >> appendModifier
+    
+    /// Prevent any further events from occurring after this one fires
+    let Consume = appendModifier "consume"
+    
+    /// Configure queueing when events fire when others are in flight; if unspecified, the default is "last"
+    let Queue = sprintf "queue:%s" >> appendModifier
+    
+    /// Queue the first event, discard all others (i.e., a FIFO queue of 1)
+    let QueueFirst = Queue "first"
+    
+    /// Queue the last event; discards current when another is received (i.e., a LIFO queue of 1)
+    let QueueLast = Queue "last"
+    
+    /// Queue all events; discard none
+    let QueueAll = Queue "all"
+    
+    /// Queue no events; discard all
+    let QueueNone = Queue "none"
 
 
-/// Attributes and flags for HTMX
+/// Helper to create the `hx-vals` attribute
+[<RequireQualifiedAccess>]
+module HxVals =
+    
+    /// Create values from a list of key/value pairs
+    let From = toJson
+
+
+/// Attributes and flags for htmx
 [<AutoOpen>]
 module HtmxAttrs =
+    
     /// Progressively enhances anchors and forms to use AJAX requests (use `_hxNoBoost` to set to false)
     let _hxBoost      = attr "hx-boost" "true"
+    
     /// Shows a confirm() dialog before issuing a request
     let _hxConfirm    = attr "hx-confirm"
+    
     /// Issues a DELETE to the specified URL
     let _hxDelete     = attr "hx-delete"
+    
     /// Disables htmx processing for the given node and any children nodes
     let _hxDisable    = flag "hx-disable"
+    
+    /// Disinherit all ("*") or specific htmx attributes
+    let _hxDisinherit = attr "hx-disinherit"
+    
     /// Changes the request encoding type
     let _hxEncoding   = attr "hx-encoding"
+    
     /// Extensions to use for this element
     let _hxExt        = attr "hx-ext"
+    
     /// Issues a GET to the specified URL
     let _hxGet        = attr "hx-get"
+    
     /// Adds to the headers that will be submitted with the request
     let _hxHeaders    = attr "hx-headers"
+    
     /// The element to snapshot and restore during history navigation
     let _hxHistoryElt = flag "hx-history-elt"
+    
     /// Includes additional data in AJAX requests
     let _hxInclude    = attr "hx-include"
+    
     /// The element to put the htmx-request class on during the AJAX request
     let _hxIndicator  = attr "hx-indicator"
+    
     /// Overrides a previous `hx-boost`
     let _hxNoBoost    = attr "hx-boost" "false"
+    
     /// Filters the parameters that will be submitted with a request
     let _hxParams     = attr "hx-params"
+    
     /// Issues a PATCH to the specified URL
     let _hxPatch      = attr "hx-patch"
+    
     /// Issues a POST to the specified URL
     let _hxPost       = attr "hx-post"
+    
     /// Preserves an element between requests
     let _hxPreserve   = attr "hx-preserve" "true"
+    
     /// Shows a prompt before submitting a request
     let _hxPrompt     = attr "hx-prompt"
+    
     /// Pushes the URL into the location bar, creating a new history entry
-  let _hxPushUrl    = flag "hx-push-url"
+    let _hxPushUrl    = attr "hx-push-url"
+    
     /// Issues a PUT to the specified URL
     let _hxPut        = attr "hx-put"
+    
+    /// Replaces the current URL in the browser's history stack
+    let _hxReplaceUrl = attr "hx-replace-url"
+    
     /// Configures various aspects of the request
     let _hxRequest    = attr "hx-request"
+    
     /// Selects a subset of the server response to process
     let _hxSelect     = attr "hx-select"
+    
+    /// 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"
+    
     /// Marks content in a response as being "Out of Band", i.e. swapped somewhere other than the target
     let _hxSwapOob    = attr "hx-swap-oob"
+    
+    /// Synchronize events based on another element
+    let _hxSync       = attr "hx-sync"
+    
     /// Specifies the target element to be swapped
     let _hxTarget     = attr "hx-target"
+    
     /// Specifies the event that triggers the request
     let _hxTrigger    = attr "hx-trigger"
+    
     /// Adds to the parameters that will be submitted with the request
     let _hxVals       = attr "hx-vals"
+    
     /// Establishes a WebSocket or sends information to one
     let _hxWs         = attr "hx-ws"
+
+
+/// Script tags to pull htmx into an web page
+module Script =
+  
+    /// Script tag to load the minified version from unpkg.com
+    let minified =
+        script [ _src         "https://unpkg.com/htmx.org@1.8.0"
+                 _integrity   "sha384-cZuAZ+ZbwkNRnrKi05G/fjBX+azI9DNOkNYysZ0I/X5ZFgsmMiBXgDZof30F5ofc"
+                 _crossorigin "anonymous" ] []
+
+    /// Script tag to load the unminified version from unpkg.com
+    let unminified =
+        script [ _src         "https://unpkg.com/htmx.org@1.8.0/dist/htmx.js"
+                 _integrity   "sha384-mrsv860ohrJ5KkqRxwXXj6OIT6sONUxOd+1kvbqW351hQd7JlfFnM0tLetA76GU0"
+                 _crossorigin "anonymous" ] []

src/ViewEngine.Htmx/README.md

@@ -0,0 +1,53 @@
+## Giraffe.ViewEngine.Htmx
+
+This package enables [htmx](https://htmx.org) support within the [Giraffe](https://giraffe.wiki) view engine.
+
+**htmx version: 1.8.0**
+
+### Setup
+
+1. Install the package.
+2. Prior to using the attribute or support modules, `open Giraffe.ViewEngine.Htmx`.
+
+### Use
+
+Following Giraffe View Engine's lead, there are a set of attribute functions for htmx; for many of the attributes, there are also helper modules to assist with typing the values. The example below utilizes both:
+
+```fsharp
+  let autoload =
+    div [ _hxGet "/this/data"; _hxTrigger HxTrigger.Load ] [ str "Loading..." ]
+```
+
+Support modules include:
+- `HxEncoding`
+- `HxHeaders`
+- `HxParams`
+- `HxRequest`
+- `HxSwap` (requires `open Giraffe.Htmx`)
+- `HxTrigger`
+- `HxVals`
+
+There are two `XmlNode`s that will load the htmx script from unpkg; `Htmx.Script.minified` loads the minified version, and `Htmx.Script.unminified` loads the unminified version (useful for debugging).
+
+### Learn
+
+htmx's attributes and these attribute functions map one-to-one. The lone exception is `_hxBoost`, which implies `true`; use `_hxNoBoost` to set it to `false`. The support modules contain named properties for known values (as illustrated with `HxTrigger.Load` above). A few of the modules are more than collections of names, though:
+- `HxRequest` has a `Configure` function, which takes a list of strings; the other functions in the module allow for configuring the request.
+
+```fsharp
+  HxRequest.Configure [ HxRequest.Timeout 500 ] |> _hxRequest 
+```
+- `HxTrigger` is _(by far)_ the most complex of these modules. Most uses won't need that complexity; however, complex triggers can be defined by piping into or composing with other functions. For example, to define an event that responds to a shift-click anywhere on the document, with a delay of 3 seconds before firing:
+
+```fsharp
+  HxTrigger.Click
+  |> HxTrigger.Filter.Shift
+  |> HxTrigger.FromDocument
+  |> HxTrigger.Delay "3s"
+  |> _hxTrigger
+  
+  // or
+  
+  (HxTrigger.Filter.Shift >> HxTrigger.FromDocument >> HxTrigger.Delay "3s") HxTrigger.Click
+  |> _hxTrigger
+```