Giraffe.Htmx 2.0.0-beta1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of Giraffe.Htmx.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Giraffe.Htmx --version 2.0.0-beta1                

                    
                

            
NuGet\Install-Package Giraffe.Htmx -Version 2.0.0-beta1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Giraffe.Htmx" Version="2.0.0-beta1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Giraffe.Htmx --version 2.0.0-beta1                

                    
                

            
#r "nuget: Giraffe.Htmx, 2.0.0-beta1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Giraffe.Htmx as a Cake Addin
#addin nuget:?package=Giraffe.Htmx&version=2.0.0-beta1&prerelease

// Install Giraffe.Htmx as a Cake Tool
#tool nuget:?package=Giraffe.Htmx&version=2.0.0-beta1&prerelease

Giraffe.Htmx

This package enables server-side support for htmx within Giraffe and ASP.NET's HttpContext.

htmx version: 2.0.0-beta1

Note that htmx 2.0 is a BETA release. The migration guide does not currently specify any request or response header changes. This means that, as of this release, there are no required code changes in moving to this major version.

Setup

  1. Install the package (must use --Prerelease flag).
  2. Prior to using the request header extension properties or the header-setting HttpHandlers, open Giraffe.Htmx.

Use

To obtain a request header, using the IHeaderDictionary extension properties:

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:

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.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.3 168 10/18/2024
2.0.2 268 8/13/2024
2.0.1 73 7/29/2024
2.0.0 679 6/18/2024
2.0.0-beta4 136 5/23/2024
2.0.0-beta3 105 4/18/2024
2.0.0-beta1 105 3/19/2024
2.0.0-alpha2 138 2/12/2024
2.0.0-alpha1 123 1/31/2024
1.9.12 1,498 4/18/2024
1.9.11 1,352 3/19/2024
1.9.10 564 1/3/2024
1.9.8 344 11/22/2023
1.9.6 276 9/28/2023
1.9.5 179 8/25/2023
1.9.4 299 7/26/2023
1.9.3 170 7/15/2023
1.9.2 371 5/6/2023
1.9.0 213 4/14/2023
1.8.6 270 3/3/2023
1.8.5 3,977 1/18/2023
1.8.4 1,562 11/24/2022
1.8.0 2,429 7/14/2022
1.7.0 1,214 2/24/2022
1.6.1 284 1/7/2022
0.9.3 1,467 11/26/2021
0.9.2 320 11/11/2021
0.9.1 321 11/8/2021

Update script tags to pull htmx 2.0.0-beta1