Compare commits

...

30 Commits
v1.8.6 ... main

Author SHA1 Message Date
f0de18845f Update script tags and package version to 2.0.2 2024-08-12 21:36:47 -04:00
961307fd99 Update htmx script to 2.0.1 2024-07-29 18:06:19 -04:00
a2960a79c6 Add pack script; drop beta tag 2024-06-18 19:38:28 -04:00
541384a92f htmx v2
- Drop `hx-sse` and `hx-ws` attributes
- Drop explicit .NET 7 support
- Update deps to latest versions
2024-06-18 19:16:10 -04:00
8cb5d6bfa7 Merge pull request 'htmx v2-beta4' (#12) from v2-beta4 into main
Reviewed-on: #12
2024-05-23 23:30:58 +00:00
1a11e3511a Update htmx to v2.0.0-beta4 2024-05-23 19:26:00 -04:00
32e962416d Migrate PR 10 from GitHub
https://github.com/bit-badger/Giraffe.Htmx/pull/10
2024-05-23 19:19:07 -04:00
29839fa795 Update script tags for v2.0.0 beta3
- Update paths in package metadata
2024-04-17 22:25:06 -04:00
7f9b3a6234 Merge branch 'htmx-version-2' 2024-04-17 22:06:23 -04:00
a8d2b819dc Merge branch 'htmx-version-2' of https://git.bitbadger.solutions/bit-badger/Giraffe.Htmx into htmx-version-2 2024-04-17 22:04:21 -04:00
1ea05b79ed Update for htmx v1.9.11 2024-03-18 20:14:51 -04:00
4f6bb8367a Update for v2 beta 1 2024-03-18 20:03:18 -04:00
b3665a4b72
Update CI to Node 20-based versions 2024-02-12 18:29:27 -05:00
bdb7255a1c Update for v2 alpha 2 2024-02-12 17:45:16 -05:00
9276db7ffe
Sync changes from main 2024-01-30 23:04:19 -05:00
94b68f76c9
Add workflow dispatch to CI 2024-01-30 23:02:45 -05:00
90de16529c
Move packaging to .NET 8 2024-01-30 22:58:45 -05:00
452f15b2d4 Add alpha tag 2024-01-30 22:55:36 -05:00
59246ae7f5
Add v2 branch to CI 2024-01-30 22:48:08 -05:00
16355e8f58 Add v2.0.0-alpha1 support 2024-01-30 22:46:34 -05:00
71286b9064 Move FSharp.Core version to .fsproj files
- Change event DU to struct
2024-01-02 19:26:09 -05:00
85ac22877c
v1.9.10 (#9) 2024-01-02 19:02:24 -05:00
dea2323499 Update NuGet READMEs 2023-11-22 16:13:57 -05:00
fcaaa693bc Bump htmx version; add .NET 8 support 2023-11-22 16:09:52 -05:00
8fd6af8c26 Add support for hx-disabled-elt
- Update script tag to 1.9.6
2023-09-27 20:31:56 -04:00
69a4034661 Update to htmx 1.9.5 2023-08-25 12:36:30 -04:00
5aa9408e60 Update to htmx 1.9.4 2023-07-26 12:54:48 -04:00
98f53a5e53 Add HX-Reselect; update for 1.9.3 2023-07-15 17:54:01 -04:00
7798314fb8 Update script tags for v1.9.2 2023-05-06 13:14:58 -04:00
50c66435e8 Add _hxOn and _hxSwapWithTransition
- Update scripts and version to 1.9.0
2023-04-14 16:56:08 -04:00
19 changed files with 702 additions and 85 deletions

View File

@ -2,9 +2,10 @@ name: CI
on: on:
push: push:
branches: [ "main" ] branches: [ "main", "htmx-version-2" ]
pull_request: pull_request:
branches: [ "main" ] branches: [ "main" ]
workflow_dispatch:
jobs: jobs:
build-and-test: build-and-test:
@ -13,12 +14,12 @@ jobs:
strategy: strategy:
matrix: matrix:
dotnet-version: [ "6.0", "7.0" ] dotnet-version: [ "6.0", "7.0", "8.0" ]
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- name: Setup .NET ${{ matrix.dotnet-version }}.x - name: Setup .NET ${{ matrix.dotnet-version }}.x
uses: actions/setup-dotnet@v3 uses: actions/setup-dotnet@v4
with: with:
dotnet-version: ${{ matrix.dotnet-version }}.x dotnet-version: ${{ matrix.dotnet-version }}.x
- name: Restore dependencies - name: Restore dependencies
@ -31,11 +32,11 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: build-and-test needs: build-and-test
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v4
- name: Setup .NET - name: Setup .NET
uses: actions/setup-dotnet@v3 uses: actions/setup-dotnet@v4
with: with:
dotnet-version: "7.0" dotnet-version: "8.0"
- name: Package Common library - name: Package Common library
run: dotnet pack src/Common/Giraffe.Htmx.Common.fsproj -c Release run: dotnet pack src/Common/Giraffe.Htmx.Common.fsproj -c Release
- name: Move Common package - name: Move Common package
@ -49,7 +50,7 @@ jobs:
- name: Move View Engine package - name: Move View Engine package
run: cp src/ViewEngine.Htmx/bin/Release/Giraffe.ViewEngine.Htmx.*.nupkg . run: cp src/ViewEngine.Htmx/bin/Release/Giraffe.ViewEngine.Htmx.*.nupkg .
- name: Save Packages - name: Save Packages
uses: actions/upload-artifact@v3 uses: actions/upload-artifact@v4
with: with:
name: packages name: packages
path: | path: |

2
.gitignore vendored
View File

@ -5,3 +5,5 @@
.ionide .ionide
.idea .idea
*.user *.user
.vscode
src/*.nupkg

View File

@ -21,22 +21,23 @@ In addition to the regular HTTP request payloads, htmx sets [one or more headers
A server may want to respond to a request that originated from htmx differently than a regular request. One way htmx can provide the same feel as a Single Page Application (SPA) is by swapping out the `body` content (or an element within it) instead of reloading the entire page. In this case, the developer can provide a partial layout to be used for these responses, while returning the full page for regular requests. The `IsHtmx` property makes this easy... A server may want to respond to a request that originated from htmx differently than a regular request. One way htmx can provide the same feel as a Single Page Application (SPA) is by swapping out the `body` content (or an element within it) instead of reloading the entire page. In this case, the developer can provide a partial layout to be used for these responses, while returning the full page for regular requests. The `IsHtmx` property makes this easy...
```fsharp ```fsharp
// "partial" and "full" are handlers that return the contents; // "partial" and "full" are handlers that return the contents;
// "view" can be whatever your view engine needs for the body of the page // "view" can be whatever your view engine needs for the body of the page
let result view : HttpHandler = let result view : HttpHandler =
fun next ctx -> 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. 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.
```fsharp ```fsharp
let theHandler : HttpHandler = let theHandler : HttpHandler =
fun next ctx -> fun next ctx ->
// some interesting stuff // some interesting stuff
withHxRedirect "/the-new-url" >=> Successful.OK withHxRedirect "/the-new-url" >=> Successful.OK
``` ```
Of note is that the `HX-Trigger` headers can take either one or more events. For a single event with no parameters, use `withHxTrigger`; for a single event with parameters, or multiple events, use `withHxTriggerMany`. Both these have `AfterSettle` and `AfterSwap` versions as well. Of note is that the `HX-Trigger` headers can take either one or more events. For a single event with no parameters, use `withHxTrigger`; for a single event with parameters, or multiple events, use `withHxTriggerMany`. Both these have `AfterSettle` and `AfterSwap` versions as well.
@ -48,8 +49,10 @@ As htmx uses [attributes](https://htmx.org/docs/#attributes) to extend HTML, the
As an example, creating a `div` that loads data once the HTML is rendered: As an example, creating a `div` that loads data once the HTML is rendered:
```fsharp ```fsharp
let autoload = 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.)_ _(As `hx-boost="true"` is the usual desire for boosting, `_hxBoost` implies true. To disable it for an element, use `_hxNoBoost` instead.)_
@ -57,20 +60,20 @@ _(As `hx-boost="true"` is the usual desire for boosting, `_hxBoost` implies true
Some attributes have known values, such as `hx-trigger` and `hx-swap`; for these, there are modules with those values. For example, `HxTrigger.Load` could be used in the example above, to ensure that the known values are spelled correctly. `hx-trigger` can also take modifiers, such as an action that only responds to `Ctrl`+click. The `HxTrigger` module has a `Filter` submodule to assist with defining these actions. Some attributes have known values, such as `hx-trigger` and `hx-swap`; for these, there are modules with those values. For example, `HxTrigger.Load` could be used in the example above, to ensure that the known values are spelled correctly. `hx-trigger` can also take modifiers, such as an action that only responds to `Ctrl`+click. The `HxTrigger` module has a `Filter` submodule to assist with defining these actions.
```fsharp ```fsharp
let shiftClick = let shiftClick =
p [ _hxGet = "/something"; _hxTrigger (HxTrigger.Filter.Shift HxTrigger.Click) ] [ p [ _hxGet = "/something"; _hxTrigger (HxTrigger.Filter.Shift HxTrigger.Click) ] [
str "hold down Shift and click me" str "hold down Shift and click me"
] ]
``` ```
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. 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 ## 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/). The author hangs out in the #dotnet-htmx channel (and most others) 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/).
## Thanks ## Thanks
|[<img src="https://giraffe.wiki/giraffe.png" alt="Giraffe logo" width="200">](https://giraffe.wiki)|[<img src="https://bitbadger.solutions/htmx-black-transparent.svg" alt="htmx logo" width="200">](https://htmx.org)|[<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main)" width="200">](https://jb.gg/OpenSource)| |[<img src="https://giraffe.wiki/giraffe.png" alt="Giraffe logo" width="200">](https://giraffe.wiki)| [<img src="https://bitbadger.solutions/upload/bit-badger/2024/01/htmx-black-transparent.svg" alt="htmx logo" width="200">](https://htmx.org) |[<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main)" width="200">](https://jb.gg/OpenSource)|
| :---: | :---: | :---: | | :---: |:------------------------------------------------------------------------------------------------------------------------------------:| :---: |
|for making ASP.NET Core functional|for making HTML cool again|for licensing their tools to this project| |for making ASP.NET Core functional| for making HTML cool again |for licensing their tools to this project|

View File

@ -1,4 +1,4 @@
/// Common definitions shared between attribute values and response headers /// Common definitions shared between attribute values and response headers
[<AutoOpen>] [<AutoOpen>]
module Giraffe.Htmx.Common module Giraffe.Htmx.Common

View File

@ -9,6 +9,11 @@
<ItemGroup> <ItemGroup>
<Compile Include="Common.fs" /> <Compile Include="Common.fs" />
<None Include="README.md" Pack="true" PackagePath="\" /> <None Include="README.md" Pack="true" PackagePath="\" />
<None Include="..\icon.png" Pack="true" PackagePath="\" />
</ItemGroup>
<ItemGroup>
<PackageReference Update="FSharp.Core" Version="6.0.0" />
</ItemGroup> </ItemGroup>
</Project> </Project>

View File

@ -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. 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: 1.8.6** **htmx version: 2.0.2**

View File

@ -1,17 +1,17 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?> <?xml version="1.0" encoding="utf-8" standalone="no"?>
<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> <Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup> <PropertyGroup>
<TargetFrameworks>net6.0;net7.0</TargetFrameworks> <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
<VersionPrefix>1.8.6</VersionPrefix> <VersionPrefix>2.0.2</VersionPrefix>
<PackageReleaseNotes>Update script tags for htmx 1.8.6</PackageReleaseNotes> <PackageReleaseNotes>Update script tags to pull htmx 2.0.2 (no header or attribute changes)</PackageReleaseNotes>
<Authors>danieljsummers</Authors> <Authors>danieljsummers</Authors>
<Company>Bit Badger Solutions</Company> <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> <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> <RepositoryType>Git</RepositoryType>
<Copyright>MIT License</Copyright> <Copyright>MIT License</Copyright>
<PackageLicenseExpression>MIT</PackageLicenseExpression> <PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageTags>Giraffe htmx</PackageTags> <PackageTags>Giraffe htmx</PackageTags>
</PropertyGroup> </PropertyGroup>
</Project> </Project>

View File

@ -9,10 +9,12 @@
<ItemGroup> <ItemGroup>
<Compile Include="Htmx.fs" /> <Compile Include="Htmx.fs" />
<None Include="README.md" Pack="true" PackagePath="\" /> <None Include="README.md" Pack="true" PackagePath="\" />
<None Include="..\icon.png" Pack="true" PackagePath="\" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Giraffe" Version="5.0.0" /> <PackageReference Include="Giraffe" Version="6.4.0" />
<PackageReference Update="FSharp.Core" Version="6.0.0" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>

View File

@ -1,4 +1,4 @@
module Giraffe.Htmx module Giraffe.Htmx
open Microsoft.AspNetCore.Http open Microsoft.AspNetCore.Http
open Microsoft.Extensions.Primitives open Microsoft.Extensions.Primitives
@ -94,6 +94,10 @@ module Handlers =
let withHxNoReplaceUrl : HttpHandler = let withHxNoReplaceUrl : HttpHandler =
toLowerBool false |> withHxReplaceUrl toLowerBool false |> withHxReplaceUrl
/// Override which portion of the response will be swapped into the target document
let withHxReselect : string -> HttpHandler =
setHttpHeader "HX-Reselect"
/// Override the `hx-swap` attribute from the initiating element /// Override the `hx-swap` attribute from the initiating element
let withHxReswap : string -> HttpHandler = let withHxReswap : string -> HttpHandler =
setHttpHeader "HX-Reswap" setHttpHeader "HX-Reswap"

View File

@ -2,7 +2,9 @@
This package enables server-side support for [htmx](https://htmx.org) within [Giraffe](https://giraffe.wiki) and ASP.NET's `HttpContext`. 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.6** **htmx version: 2.0.2**
_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 ### Setup
@ -14,20 +16,20 @@ This package enables server-side support for [htmx](https://htmx.org) within [Gi
To obtain a request header, using the `IHeaderDictionary` extension properties: To obtain a request header, using the `IHeaderDictionary` extension properties:
```fsharp ```fsharp
let myHandler : HttpHander = let myHandler : HttpHander =
fun next ctx -> fun next ctx ->
match ctx.HxPrompt with match ctx.HxPrompt with
| Some prompt -> ... // do something with the text the user provided | Some prompt -> ... // do something with the text the user provided
| None -> ... // no text provided | None -> ... // no text provided
``` ```
To set a response header: To set a response header:
```fsharp ```fsharp
let myHandler : HttpHander = let myHandler : HttpHander =
fun next ctx -> fun next ctx ->
// some meaningful work // some meaningful work
withHxPushUrl "/some/new/url" >=> [other handlers] 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. 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.

View File

@ -265,6 +265,14 @@ let handlers =
Expect.isTrue (dic.ContainsKey "HX-Replace-Url") "The HX-Replace-Url header should be present" Expect.isTrue (dic.ContainsKey "HX-Replace-Url") "The HX-Replace-Url header should be present"
Expect.equal dic["HX-Replace-Url"].[0] "false" "The HX-Replace-Url value was incorrect" Expect.equal dic["HX-Replace-Url"].[0] "false" "The HX-Replace-Url value was incorrect"
} }
testTask "withHxReselect succeeds" {
let ctx = Substitute.For<HttpContext> ()
let dic = HeaderDictionary ()
ctx.Response.Headers.ReturnsForAnyArgs dic |> ignore
let! _ = withHxReselect "#test" next ctx
Expect.isTrue (dic.ContainsKey "HX-Reselect") "The HX-Reselect header should be present"
Expect.equal dic["HX-Reselect"].[0] "#test" "The HX-Reselect value was incorrect"
}
testTask "withHxReswap succeeds" { testTask "withHxReswap succeeds" {
let ctx = Substitute.For<HttpContext> () let ctx = Substitute.For<HttpContext> ()
let dic = HeaderDictionary () let dic = HeaderDictionary ()

View File

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

View File

@ -18,8 +18,9 @@
</ItemGroup> </ItemGroup>
<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> </ItemGroup>
</Project> </Project>

View File

@ -15,6 +15,399 @@ let hxEncoding =
} }
] ]
let hxEvent =
testList "HxEvent" [
testList "Abort" [
test "ToString succeeds" {
Expect.equal (string Abort) "abort" "Abort event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (Abort.ToHxOnString()) "abort" "Abort hx-on event name not correct"
}
]
testList "AfterOnLoad" [
test "ToString succeeds" {
Expect.equal (string AfterOnLoad) "afterOnLoad" "AfterOnLoad event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (AfterOnLoad.ToHxOnString()) "after-on-load" "AfterOnLoad hx-on event name not correct"
}
]
testList "AfterProcessNode" [
test "ToString succeeds" {
Expect.equal (string AfterProcessNode) "afterProcessNode" "AfterProcessNode event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(AfterProcessNode.ToHxOnString())
"after-process-node"
"AfterProcessNode hx-on event name not correct"
}
]
testList "AfterRequest" [
test "ToString succeeds" {
Expect.equal (string AfterRequest) "afterRequest" "AfterRequest event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (AfterRequest.ToHxOnString()) "after-request" "AfterRequest hx-on event name not correct"
}
]
testList "AfterSettle" [
test "ToString succeeds" {
Expect.equal (string AfterSettle) "afterSettle" "AfterSettle event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (AfterSettle.ToHxOnString()) "after-settle" "AfterSettle hx-on event name not correct"
}
]
testList "AfterSwap" [
test "ToString succeeds" {
Expect.equal (string AfterSwap) "afterSwap" "AfterSwap event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (AfterSwap.ToHxOnString()) "after-swap" "AfterSwap hx-on event name not correct"
}
]
testList "BeforeCleanupElement" [
test "ToString succeeds" {
Expect.equal
(string BeforeCleanupElement) "beforeCleanupElement" "BeforeCleanupElement event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(BeforeCleanupElement.ToHxOnString())
"before-cleanup-element"
"BeforeCleanupElement hx-on event name not correct"
}
]
testList "BeforeOnLoad" [
test "ToString succeeds" {
Expect.equal (string BeforeOnLoad) "beforeOnLoad" "BeforeOnLoad event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (BeforeOnLoad.ToHxOnString()) "before-on-load" "BeforeOnLoad hx-on event name not correct"
}
]
testList "BeforeProcessNode" [
test "ToString succeeds" {
Expect.equal (string BeforeProcessNode) "beforeProcessNode" "BeforeProcessNode event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(BeforeProcessNode.ToHxOnString())
"before-process-node"
"BeforeProcessNode hx-on event name not correct"
}
]
testList "BeforeRequest" [
test "ToString succeeds" {
Expect.equal (string BeforeRequest) "beforeRequest" "BeforeRequest event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(BeforeRequest.ToHxOnString()) "before-request" "BeforeRequest hx-on event name not correct"
}
]
testList "BeforeSwap" [
test "ToString succeeds" {
Expect.equal (string BeforeSwap) "beforeSwap" "BeforeSwap event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (BeforeSwap.ToHxOnString()) "before-swap" "BeforeSwap hx-on event name not correct"
}
]
testList "BeforeSend" [
test "ToString succeeds" {
Expect.equal (string BeforeSend) "beforeSend" "BeforeSend event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (BeforeSend.ToHxOnString()) "before-send" "BeforeSend hx-on event name not correct"
}
]
testList "ConfigRequest" [
test "ToString succeeds" {
Expect.equal (string ConfigRequest) "configRequest" "ConfigRequest event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(ConfigRequest.ToHxOnString()) "config-request" "ConfigRequest hx-on event name not correct"
}
]
testList "Confirm" [
test "ToString succeeds" {
Expect.equal (string Confirm) "confirm" "Confirm event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (Confirm.ToHxOnString()) "confirm" "Confirm hx-on event name not correct"
}
]
testList "HistoryCacheError" [
test "ToString succeeds" {
Expect.equal (string HistoryCacheError) "historyCacheError" "HistoryCacheError event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(HistoryCacheError.ToHxOnString())
"history-cache-error"
"HistoryCacheError hx-on event name not correct"
}
]
testList "HistoryCacheMiss" [
test "ToString succeeds" {
Expect.equal (string HistoryCacheMiss) "historyCacheMiss" "HistoryCacheMiss event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(HistoryCacheMiss.ToHxOnString())
"history-cache-miss"
"HistoryCacheMiss hx-on event name not correct"
}
]
testList "HistoryCacheMissError" [
test "ToString succeeds" {
Expect.equal
(string HistoryCacheMissError)
"historyCacheMissError"
"HistoryCacheMissError event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(HistoryCacheMissError.ToHxOnString())
"history-cache-miss-error"
"HistoryCacheMissError hx-on event name not correct"
}
]
testList "HistoryCacheMissLoad" [
test "ToString succeeds" {
Expect.equal
(string HistoryCacheMissLoad) "historyCacheMissLoad" "HistoryCacheMissLoad event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(HistoryCacheMissLoad.ToHxOnString())
"history-cache-miss-load"
"HistoryCacheMissLoad hx-on event name not correct"
}
]
testList "HistoryRestore" [
test "ToString succeeds" {
Expect.equal (string HistoryRestore) "historyRestore" "HistoryRestore event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(HistoryRestore.ToHxOnString()) "history-restore" "HistoryRestore hx-on event name not correct"
}
]
testList "BeforeHistorySave" [
test "ToString succeeds" {
Expect.equal (string BeforeHistorySave) "beforeHistorySave" "BeforeHistorySave event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(BeforeHistorySave.ToHxOnString())
"before-history-save"
"BeforeHistorySave hx-on event name not correct"
}
]
testList "Load" [
test "ToString succeeds" {
Expect.equal (string Load) "load" "Load event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (Load.ToHxOnString()) "load" "Load hx-on event name not correct"
}
]
testList "NoSseSourceError" [
test "ToString succeeds" {
Expect.equal (string NoSseSourceError) "noSSESourceError" "NoSseSourceError event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(NoSseSourceError.ToHxOnString())
"no-sse-source-error"
"NoSseSourceError hx-on event name not correct"
}
]
testList "OnLoadError" [
test "ToString succeeds" {
Expect.equal (string OnLoadError) "onLoadError" "OnLoadError event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (OnLoadError.ToHxOnString()) "on-load-error" "OnLoadError hx-on event name not correct"
}
]
testList "OobAfterSwap" [
test "ToString succeeds" {
Expect.equal (string OobAfterSwap) "oobAfterSwap" "OobAfterSwap event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (OobAfterSwap.ToHxOnString()) "oob-after-swap" "OobAfterSwap hx-on event name not correct"
}
]
testList "OobBeforeSwap" [
test "ToString succeeds" {
Expect.equal (string OobBeforeSwap) "oobBeforeSwap" "OobBeforeSwap event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(OobBeforeSwap.ToHxOnString()) "oob-before-swap" "OobBeforeSwap hx-on event name not correct"
}
]
testList "OobErrorNoTarget" [
test "ToString succeeds" {
Expect.equal (string OobErrorNoTarget) "oobErrorNoTarget" "OobErrorNoTarget event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(OobErrorNoTarget.ToHxOnString())
"oob-error-no-target"
"OobErrorNoTarget hx-on event name not correct"
}
]
testList "Prompt" [
test "ToString succeeds" {
Expect.equal (string Prompt) "prompt" "Prompt event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (Prompt.ToHxOnString()) "prompt" "Prompt hx-on event name not correct"
}
]
testList "PushedIntoHistory" [
test "ToString succeeds" {
Expect.equal (string PushedIntoHistory) "pushedIntoHistory" "PushedIntoHistory event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(PushedIntoHistory.ToHxOnString())
"pushed-into-history"
"PushedIntoHistory hx-on event name not correct"
}
]
testList "ResponseError" [
test "ToString succeeds" {
Expect.equal (string ResponseError) "responseError" "ResponseError event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(ResponseError.ToHxOnString()) "response-error" "ResponseError hx-on event name not correct"
}
]
testList "SendError" [
test "ToString succeeds" {
Expect.equal (string SendError) "sendError" "SendError event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (SendError.ToHxOnString()) "send-error" "SendError hx-on event name not correct"
}
]
testList "SseError" [
test "ToString succeeds" {
Expect.equal (string SseError) "sseError" "SseError event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (SseError.ToHxOnString()) "sse-error" "SseError hx-on event name not correct"
}
]
testList "SseOpen" [
test "ToString succeeds" {
Expect.equal (string SseOpen) "sseOpen" "SseOpen event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (SseOpen.ToHxOnString()) "sse-open" "SseOpen hx-on event name not correct"
}
]
testList "SwapError" [
test "ToString succeeds" {
Expect.equal (string SwapError) "swapError" "SwapError event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (SwapError.ToHxOnString()) "swap-error" "SwapError hx-on event name not correct"
}
]
testList "TargetError" [
test "ToString succeeds" {
Expect.equal (string TargetError) "targetError" "TargetError event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (TargetError.ToHxOnString()) "target-error" "TargetError hx-on event name not correct"
}
]
testList "Timeout" [
test "ToString succeeds" {
Expect.equal (string Timeout) "timeout" "Timeout event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (Timeout.ToHxOnString()) "timeout" "Timeout hx-on event name not correct"
}
]
testList "ValidationValidate" [
test "ToString succeeds" {
Expect.equal
(string ValidationValidate) "validation:validate" "ValidationValidate event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(ValidationValidate.ToHxOnString())
"validation:validate"
"ValidationValidate hx-on event name not correct"
}
]
testList "ValidationFailed" [
test "ToString succeeds" {
Expect.equal (string ValidationFailed) "validation:failed" "ValidationFailed event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(ValidationFailed.ToHxOnString())
"validation:failed"
"ValidationFailed hx-on event name not correct"
}
]
testList "ValidationHalted" [
test "ToString succeeds" {
Expect.equal (string ValidationHalted) "validation:halted" "ValidationHalted event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal
(ValidationHalted.ToHxOnString())
"validation:halted"
"ValidationHalted hx-on event name not correct"
}
]
testList "XhrAbort" [
test "ToString succeeds" {
Expect.equal (string XhrAbort) "xhr:abort" "XhrAbort event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (XhrAbort.ToHxOnString()) "xhr:abort" "XhrAbort hx-on event name not correct"
}
]
testList "XhrLoadEnd" [
test "ToString succeeds" {
Expect.equal (string XhrLoadEnd) "xhr:loadend" "XhrLoadEnd event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (XhrLoadEnd.ToHxOnString()) "xhr:loadend" "XhrLoadEnd hx-on event name not correct"
}
]
testList "XhrLoadStart" [
test "ToString succeeds" {
Expect.equal (string XhrLoadStart) "xhr:loadstart" "XhrLoadStart event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (XhrLoadStart.ToHxOnString()) "xhr:loadstart" "XhrLoadStart hx-on event name not correct"
}
]
testList "XhrProgress" [
test "ToString succeeds" {
Expect.equal (string XhrProgress) "xhr:progress" "XhrProgress event name not correct"
}
test "ToHxOnString succeeds" {
Expect.equal (XhrProgress.ToHxOnString()) "xhr:progress" "XhrProgress hx-on event name not correct"
}
]
]
/// Tests for the HxHeaders module /// Tests for the HxHeaders module
let hxHeaders = let hxHeaders =
testList "HxHeaders" [ testList "HxHeaders" [
@ -293,14 +686,14 @@ let hxVals =
] ]
] ]
/// Pipe-able assertion for a rendered node
let shouldRender expected node =
Expect.equal (RenderView.AsString.htmlNode node) expected "Rendered HTML incorrect"
/// Tests for the HtmxAttrs module /// Tests for the HtmxAttrs module
let attributes = let attributes =
testList "Attributes" [ testList "Attributes" [
/// Pipe-able assertion for a rendered node
let shouldRender expected node =
Expect.equal (RenderView.AsString.htmlNode node) expected "Rendered HTML incorrect"
test "_hxBoost succeeds" { test "_hxBoost succeeds" {
div [ _hxBoost ] [] |> shouldRender """<div hx-boost="true"></div>""" div [ _hxBoost ] [] |> shouldRender """<div hx-boost="true"></div>"""
} }
@ -313,6 +706,9 @@ let attributes =
test "_hxDisable succeeds" { test "_hxDisable succeeds" {
p [ _hxDisable ] [] |> shouldRender """<p hx-disable></p>""" p [ _hxDisable ] [] |> shouldRender """<p hx-disable></p>"""
} }
test "_hxDisabledElt succeeds" {
button [ _hxDisabledElt "this" ] [] |> shouldRender """<button hx-disabled-elt="this"></button>"""
}
test "_hxDisinherit succeeds" { test "_hxDisinherit succeeds" {
strong [ _hxDisinherit "*" ] [] |> shouldRender """<strong hx-disinherit="*"></strong>""" strong [ _hxDisinherit "*" ] [] |> shouldRender """<strong hx-disinherit="*"></strong>"""
} }
@ -344,6 +740,13 @@ let attributes =
test "_hxNoBoost succeeds" { test "_hxNoBoost succeeds" {
td [ _hxNoBoost ] [] |> shouldRender """<td hx-boost="false"></td>""" td [ _hxNoBoost ] [] |> shouldRender """<td hx-boost="false"></td>"""
} }
test "_hxOnEvent succeeds" {
a [ _hxOnEvent "click" "doThis()" ] [] |> shouldRender """<a hx-on:click="doThis()"></a>"""
}
test "_hxOnHxEvent succeeds" {
strong [ _hxOnHxEvent BeforeSwap "changeStuff()" ] []
|> shouldRender """<strong hx-on::before-swap="changeStuff()"></strong>"""
}
test "_hxParams succeeds" { test "_hxParams succeeds" {
br [ _hxParams "[p1,p2]" ] |> shouldRender """<br hx-params="[p1,p2]">""" br [ _hxParams "[p1,p2]" ] |> shouldRender """<br hx-params="[p1,p2]">"""
} }
@ -378,13 +781,13 @@ let attributes =
test "_hxSelectOob succeeds" { test "_hxSelectOob succeeds" {
section [ _hxSelectOob "#oob" ] [] |> shouldRender """<section hx-select-oob="#oob"></section>""" 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" { test "_hxSwap succeeds" {
del [ _hxSwap "innerHTML" ] [] |> shouldRender """<del hx-swap="innerHTML"></del>""" del [ _hxSwap "innerHTML" ] [] |> shouldRender """<del hx-swap="innerHTML"></del>"""
} }
test "_hxSwapWithTransition succeeds" {
del [ _hxSwapWithTransition "innerHTML" ] []
|> shouldRender """<del hx-swap="innerHTML transition:true"></del>"""
}
test "_hxSwapOob succeeds" { test "_hxSwapOob succeeds" {
li [ _hxSwapOob "true" ] [] |> shouldRender """<li hx-swap-oob="true"></li>""" li [ _hxSwapOob "true" ] [] |> shouldRender """<li hx-swap-oob="true"></li>"""
} }
@ -401,8 +804,11 @@ let attributes =
dt [ _hxVals """{ "extra": "values" }""" ] [] dt [ _hxVals """{ "extra": "values" }""" ] []
|> shouldRender """<dt hx-vals="{ &quot;extra&quot;: &quot;values&quot; }"></dt>""" |> 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>"""
} }
] ]
@ -413,14 +819,14 @@ let script =
let html = RenderView.AsString.htmlNode Script.minified let html = RenderView.AsString.htmlNode Script.minified
Expect.equal Expect.equal
html html
"""<script src="https://unpkg.com/htmx.org@1.8.6" integrity="sha384-Bj8qm/6B+71E6FQSySofJOUjA/gq330vEqjFx9LakWybUySyI1IQHwPtbTU7bNwx" crossorigin="anonymous"></script>""" """<script src="https://unpkg.com/htmx.org@2.0.2" integrity="sha384-Y7hw+L/jvKeWIRRkqWYfPcvVxHzVzn5REgzbawhxAuQGwX1XWe70vji+VSeHOThJ" crossorigin="anonymous"></script>"""
"Minified script tag is incorrect" "Minified script tag is incorrect"
} }
test "unminified succeeds" { test "unminified succeeds" {
let html = RenderView.AsString.htmlNode Script.unminified let html = RenderView.AsString.htmlNode Script.unminified
Expect.equal Expect.equal
html html
"""<script src="https://unpkg.com/htmx.org@1.8.6/dist/htmx.js" integrity="sha384-denUmZOxhLrCvV+ej1uWe4EXwjmJtWzbg0sjv6YfuHhUAP0CEVIArcYjlUbJHh87" crossorigin="anonymous"></script>""" """<script src="https://unpkg.com/htmx.org@2.0.2/dist/htmx.js" integrity="sha384-yZq+5izaUBKcRgFbxgkRYwpHhHHCpp5nseXp0MEQ1A4MTWVMnqkmcuFez8x5qfxr" crossorigin="anonymous"></script>"""
"Unminified script tag is incorrect" "Unminified script tag is incorrect"
} }
] ]
@ -574,5 +980,15 @@ let renderFragment =
/// All tests in this module /// All tests in this module
let allTests = let allTests =
testList "ViewEngine.Htmx" testList "ViewEngine.Htmx" [
[ hxEncoding; hxHeaders; hxParams; hxRequest; hxTrigger; hxVals; attributes; script; renderFragment ] hxEncoding
hxEvent
hxHeaders
hxParams
hxRequest
hxTrigger
hxVals
attributes
script
renderFragment
]

View File

@ -9,10 +9,12 @@
<ItemGroup> <ItemGroup>
<Compile Include="Htmx.fs" /> <Compile Include="Htmx.fs" />
<None Include="README.md" Pack="true" PackagePath="\" /> <None Include="README.md" Pack="true" PackagePath="\" />
<None Include="..\icon.png" Pack="true" PackagePath="\" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="Giraffe.ViewEngine" Version="1.4.0" /> <PackageReference Include="Giraffe.ViewEngine" Version="1.4.0" />
<PackageReference Update="FSharp.Core" Version="6.0.0" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>

View File

@ -19,6 +19,147 @@ module HxEncoding =
let MultipartForm = "multipart/form-data" let MultipartForm = "multipart/form-data"
/// The events recognized by htmx
[<Struct>]
type HxEvent =
/// Send this event to an element to abort a request
| Abort
/// Triggered after an AJAX request has completed processing a successful response
| AfterOnLoad
/// Triggered after htmx has initialized a node
| AfterProcessNode
/// Triggered after an AJAX request has completed
| AfterRequest
/// Triggered after the DOM has settled
| AfterSettle
/// Triggered after new content has been swapped in
| AfterSwap
/// Triggered before htmx disables an element or removes it from the DOM
| BeforeCleanupElement
/// Triggered before any response processing occurs
| BeforeOnLoad
/// Triggered before htmx initializes a node
| BeforeProcessNode
/// Triggered before an AJAX request is made
| BeforeRequest
/// Triggered before a swap is done, allows you to configure the swap
| BeforeSwap
/// Triggered just before an ajax request is sent
| BeforeSend
/// Triggered before the request, allows you to customize parameters, headers
| ConfigRequest
/// Triggered after a trigger occurs on an element, allows you to cancel (or delay) issuing the AJAX request
| Confirm
/// Triggered on an error during cache writing
| HistoryCacheError
/// Triggered on a cache miss in the history subsystem
| HistoryCacheMiss
/// Triggered on a unsuccessful remote retrieval
| HistoryCacheMissError
/// Triggered on a successful remote retrieval
| HistoryCacheMissLoad
/// Triggered when htmx handles a history restoration action
| HistoryRestore
/// Triggered before content is saved to the history cache
| BeforeHistorySave
/// Triggered when new content is added to the DOM
| Load
/// Triggered when an element refers to a SSE event in its trigger, but no parent SSE source has been defined
| NoSseSourceError
/// Triggered when an exception occurs during the onLoad handling in htmx
| OnLoadError
/// Triggered after an out of band element as been swapped in
| OobAfterSwap
/// Triggered before an out of band element swap is done, allows you to configure the swap
| OobBeforeSwap
/// Triggered when an out of band element does not have a matching ID in the current DOM
| OobErrorNoTarget
/// Triggered after a prompt is shown
| Prompt
/// Triggered after an url is pushed into history
| PushedIntoHistory
/// Triggered when an HTTP response error (non-200 or 300 response code) occurs
| ResponseError
/// Triggered when a network error prevents an HTTP request from happening
| SendError
/// Triggered when an error occurs with a SSE source
| SseError
/// Triggered when a SSE source is opened
| SseOpen
/// Triggered when an error occurs during the swap phase
| SwapError
/// Triggered when an invalid target is specified
| TargetError
/// Triggered when a request timeout occurs
| Timeout
/// Triggered before an element is validated
| ValidationValidate
/// Triggered when an element fails validation
| ValidationFailed
/// Triggered when a request is halted due to validation errors
| ValidationHalted
/// Triggered when an ajax request aborts
| XhrAbort
/// Triggered when an ajax request ends
| XhrLoadEnd
/// Triggered when an ajax request starts
| XhrLoadStart
/// Triggered periodically during an ajax request that supports progress events
| XhrProgress
/// The htmx event name (fst) and kebab-case name (snd, for use with hx-on)
static member private Values = Map [
Abort, ("abort", "abort")
AfterOnLoad, ("afterOnLoad", "after-on-load")
AfterProcessNode, ("afterProcessNode", "after-process-node")
AfterRequest, ("afterRequest", "after-request")
AfterSettle, ("afterSettle", "after-settle")
AfterSwap, ("afterSwap", "after-swap")
BeforeCleanupElement, ("beforeCleanupElement", "before-cleanup-element")
BeforeOnLoad, ("beforeOnLoad", "before-on-load")
BeforeProcessNode, ("beforeProcessNode", "before-process-node")
BeforeRequest, ("beforeRequest", "before-request")
BeforeSwap, ("beforeSwap", "before-swap")
BeforeSend, ("beforeSend", "before-send")
ConfigRequest, ("configRequest", "config-request")
Confirm, ("confirm", "confirm")
HistoryCacheError, ("historyCacheError", "history-cache-error")
HistoryCacheMiss, ("historyCacheMiss", "history-cache-miss")
HistoryCacheMissError, ("historyCacheMissError", "history-cache-miss-error")
HistoryCacheMissLoad, ("historyCacheMissLoad", "history-cache-miss-load")
HistoryRestore, ("historyRestore", "history-restore")
BeforeHistorySave, ("beforeHistorySave", "before-history-save")
Load, ("load", "load")
NoSseSourceError, ("noSSESourceError", "no-sse-source-error")
OnLoadError, ("onLoadError", "on-load-error")
OobAfterSwap, ("oobAfterSwap", "oob-after-swap")
OobBeforeSwap, ("oobBeforeSwap", "oob-before-swap")
OobErrorNoTarget, ("oobErrorNoTarget", "oob-error-no-target")
Prompt, ("prompt", "prompt")
PushedIntoHistory, ("pushedIntoHistory", "pushed-into-history")
ResponseError, ("responseError", "response-error")
SendError, ("sendError", "send-error")
SseError, ("sseError", "sse-error")
SseOpen, ("sseOpen", "sse-open")
SwapError, ("swapError", "swap-error")
TargetError, ("targetError", "target-error")
Timeout, ("timeout", "timeout")
ValidationValidate, ("validation:validate", "validation:validate")
ValidationFailed, ("validation:failed", "validation:failed")
ValidationHalted, ("validation:halted", "validation:halted")
XhrAbort, ("xhr:abort", "xhr:abort")
XhrLoadEnd, ("xhr:loadend", "xhr:loadend")
XhrLoadStart, ("xhr:loadstart", "xhr:loadstart")
XhrProgress, ("xhr:progress", "xhr:progress")
]
/// The htmx event name
override this.ToString() = fst HxEvent.Values[this]
/// The hx-on variant of the htmx event name
member this.ToHxOnString() = snd HxEvent.Values[this]
/// Helper to create the `hx-headers` attribute /// Helper to create the `hx-headers` attribute
[<RequireQualifiedAccess>] [<RequireQualifiedAccess>]
module HxHeaders = module HxHeaders =
@ -193,6 +334,9 @@ module HtmxAttrs =
/// Disables htmx processing for the given node and any children nodes /// Disables htmx processing for the given node and any children nodes
let _hxDisable = flag "hx-disable" let _hxDisable = flag "hx-disable"
/// Specifies elements that should be disabled when an htmx request is in flight
let _hxDisabledElt = attr "hx-disabled-elt"
/// Disinherit all ("*") or specific htmx attributes /// Disinherit all ("*") or specific htmx attributes
let _hxDisinherit = attr "hx-disinherit" let _hxDisinherit = attr "hx-disinherit"
@ -223,6 +367,14 @@ module HtmxAttrs =
/// Overrides a previous `hx-boost` /// Overrides a previous `hx-boost`
let _hxNoBoost = attr "hx-boost" "false" let _hxNoBoost = attr "hx-boost" "false"
/// Attach an event handler for DOM events
let _hxOnEvent evtName =
attr $"hx-on:%s{evtName}"
/// Attach an event handler for htmx events
let _hxOnHxEvent (hxEvent: HxEvent) =
_hxOnEvent $":{hxEvent.ToHxOnString()}"
/// Filters the parameters that will be submitted with a request /// Filters the parameters that will be submitted with a request
let _hxParams = attr "hx-params" let _hxParams = attr "hx-params"
@ -256,12 +408,13 @@ module HtmxAttrs =
/// Selects a subset of an out-of-band server response /// Selects a subset of an out-of-band server response
let _hxSelectOob = attr "hx-select-oob" 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') /// Controls how the response content is swapped into the DOM (e.g. 'outerHTML' or 'beforeEnd')
let _hxSwap = attr "hx-swap" let _hxSwap = attr "hx-swap"
/// Controls how the response content is swapped into the DOM (e.g. 'outerHTML' or 'beforeEnd'), enabling CSS
/// transitions
let _hxSwapWithTransition = sprintf "%s transition:true" >> _hxSwap
/// Marks content in a response as being "Out of Band", i.e. swapped somewhere other than the target /// Marks content in a response as being "Out of Band", i.e. swapped somewhere other than the target
let _hxSwapOob = attr "hx-swap-oob" let _hxSwapOob = attr "hx-swap-oob"
@ -280,23 +433,26 @@ module HtmxAttrs =
/// Adds to the parameters that will be submitted with the request /// Adds to the parameters that will be submitted with the request
let _hxVals = attr "hx-vals" 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 = module Script =
/// Script tag to load the minified version from unpkg.com /// Script tag to load the minified version from unpkg.com
let minified = let minified =
script [ _src "https://unpkg.com/htmx.org@1.8.6" script [ _src "https://unpkg.com/htmx.org@2.0.2"
_integrity "sha384-Bj8qm/6B+71E6FQSySofJOUjA/gq330vEqjFx9LakWybUySyI1IQHwPtbTU7bNwx" _integrity "sha384-Y7hw+L/jvKeWIRRkqWYfPcvVxHzVzn5REgzbawhxAuQGwX1XWe70vji+VSeHOThJ"
_crossorigin "anonymous" ] [] _crossorigin "anonymous" ] []
/// Script tag to load the unminified version from unpkg.com /// Script tag to load the unminified version from unpkg.com
let unminified = let unminified =
script [ _src "https://unpkg.com/htmx.org@1.8.6/dist/htmx.js" script [ _src "https://unpkg.com/htmx.org@2.0.2/dist/htmx.js"
_integrity "sha384-denUmZOxhLrCvV+ej1uWe4EXwjmJtWzbg0sjv6YfuHhUAP0CEVIArcYjlUbJHh87" _integrity "sha384-yZq+5izaUBKcRgFbxgkRYwpHhHHCpp5nseXp0MEQ1A4MTWVMnqkmcuFez8x5qfxr"
_crossorigin "anonymous" ] [] _crossorigin "anonymous" ] []

View File

@ -2,7 +2,9 @@
This package enables [htmx](https://htmx.org) support within the [Giraffe](https://giraffe.wiki) view engine. This package enables [htmx](https://htmx.org) support within the [Giraffe](https://giraffe.wiki) view engine.
**htmx version: 1.8.6** **htmx version: 2.0.2**
_Upgrading from v1.x: see [the migration guide](https://htmx.org/migration-guide-htmx-1/) for changes_
### Setup ### Setup
@ -14,7 +16,7 @@ This package enables [htmx](https://htmx.org) support within the [Giraffe](https
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: 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 ```fsharp
let autoload = let autoload =
div [ _hxGet "/this/data"; _hxTrigger HxTrigger.Load ] [ str "Loading..." ] div [ _hxGet "/this/data"; _hxTrigger HxTrigger.Load ] [ str "Loading..." ]
``` ```
@ -33,23 +35,29 @@ This also supports [fragment rendering](https://bitbadger.solutions/blog/2022/fr
### Learn ### 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: htmx's attributes and these attribute functions map one-to-one. There are two exceptions:
- `_hxBoost` implies `true`; use `_hxNoBoost` to set it to `false`.
- `_hxSwapWithTransition` renders the standard `hx-swap` attribute and appends `transition:true` to the specified swap value.
The htmx `hx-on` attribute supports multiple events if they are separated with a newline (`\n`) character. The value provided to this attribute will be attribute-escaped, but in testing, it was interpreted correctly.
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. - `HxRequest` has a `Configure` function, which takes a list of strings; the other functions in the module allow for configuring the request.
```fsharp ```fsharp
HxRequest.Configure [ HxRequest.Timeout 500 ] |> _hxRequest 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: - `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 ```fsharp
HxTrigger.Click HxTrigger.Click
|> HxTrigger.Filter.Shift |> HxTrigger.Filter.Shift
|> HxTrigger.FromDocument |> HxTrigger.FromDocument
|> HxTrigger.Delay "3s" |> HxTrigger.Delay "3s"
|> _hxTrigger |> _hxTrigger
// or // or
(HxTrigger.Filter.Shift >> HxTrigger.FromDocument >> HxTrigger.Delay "3s") HxTrigger.Click (HxTrigger.Filter.Shift >> HxTrigger.FromDocument >> HxTrigger.Delay "3s") HxTrigger.Click
|> _hxTrigger |> _hxTrigger
``` ```

BIN
src/icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

7
src/pack.sh Executable file
View File

@ -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 .