Oxpecker.Htmx 1.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Oxpecker.Htmx --version 1.0.1
                    


                    

                
NuGet\Install-Package Oxpecker.Htmx -Version 1.0.1
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="Oxpecker.Htmx" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Oxpecker.Htmx" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Oxpecker.Htmx" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Oxpecker.Htmx --version 1.0.1
                    


                    

                
#r "nuget: Oxpecker.Htmx, 1.0.1"
#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. 
#:package Oxpecker.Htmx@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Oxpecker.Htmx&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Oxpecker.Htmx&version=1.0.1
                    


                            Install as a Cake Tool

Oxpecker.Htmx

Oxpecker.Htmx extends Oxpecker.ViewEngine package with HTMX attributes and headers.

Nuget package dotnet add package Oxpecker.Htmx

Markup example:

open Oxpecker.ViewEngine
open Oxpecker.Htmx

let renderForm q =
    form(action="/contacts", method="get") {
        label(for'="search") { "Search Term" }
        input(id="search", type'="search", name="q", value=q, style="margin: 0 5px", autocomplete="off",
              hxGet="/contacts",
              hxTrigger="search, keyup delay:200ms changed",
              hxTarget="tbody",
              hxPushUrl="true",
              hxIndicator="#spinner")
        img(id="spinner", class'="spinner htmx-indicator", src="/spinning-circles.svg", alt="Request In Flight...")
        input(type'="submit", value="Search").hxOn("click", "alert('clicked')")
    }

Documentation

Please refer to the official HTMX site for the documentation.

You can check ContactApp sample in the repository to get a better understanding of how the code will look like in your application.

API

Client side

After opening Oxpecker.Htmx namespace you'll get access to HTMX attributes:

  • hxGet
  • hxPost
  • hxPushUrl
  • hxSelect
  • hxSelectOob
  • hxSwap
  • hxSwapOob
  • hxTarget
  • hxTrigger
  • hxVals
  • hxBoost
  • hxConfirm
  • hxDelete
  • hxDisable
  • hxDisabledElt
  • hxDisinherit
  • hxEncoding
  • hxExt
  • hxHeaders
  • hxHistory
  • hxHistoryElt
  • hxInclude
  • hxIndicator
  • hxParams
  • hxPatch
  • hxPreserve
  • hxPrompt
  • hxPut
  • hxReplaceUrl
  • hxRequest
  • hxSync
  • hxValidate

and event handler method:

  • hxOn

Server side

After opening Oxpecker.Htmx namespace you'll get access to the header name constants:

  • HxRequestHeader.Boosted
  • HxRequestHeader.CurrentUrl
  • HxRequestHeader.HistoryRestoreRequest
  • HxRequestHeader.Prompt
  • HxRequestHeader.Request
  • HxRequestHeader.Target
  • HxRequestHeader.TriggerName
  • HxRequestHeader.Trigger

and

  • HxResponseHeader.Location
  • HxResponseHeader.PushUrl
  • HxResponseHeader.Redirect
  • HxResponseHeader.Refresh
  • HxResponseHeader.ReplaceUrl
  • HxResponseHeader.Reswap
  • HxResponseHeader.Retarget
  • HxResponseHeader.Trigger
  • HxResponseHeader.TriggerAfterSettle
  • HxResponseHeader.TriggerAfterSwap
Product Compatible and additional computed target framework versions.
.NET 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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
1.0.1 149 8/12/2025
1.0.0 1,492 11/19/2024
0.1.2 500 8/13/2024
0.1.1 337 4/29/2024
0.1.0 312 3/1/2024

Documentation update