Giraffe.ViewEngine.Htmx 1.8.0

.NET 6.0
NuGet\Install-Package Giraffe.ViewEngine.Htmx -Version 1.8.0
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.
dotnet add package Giraffe.ViewEngine.Htmx --version 1.8.0
<PackageReference Include="Giraffe.ViewEngine.Htmx" Version="1.8.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Giraffe.ViewEngine.Htmx --version 1.8.0
#r "nuget: Giraffe.ViewEngine.Htmx, 1.8.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Giraffe.ViewEngine.Htmx as a Cake Addin
#addin nuget:?package=Giraffe.ViewEngine.Htmx&version=1.8.0

// Install Giraffe.ViewEngine.Htmx as a Cake Tool
#tool nuget:?package=Giraffe.ViewEngine.Htmx&version=1.8.0

Giraffe.ViewEngine.Htmx

This package enables htmx support within the Giraffe 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:

  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 XmlNodes 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.
  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.Click
  |> HxTrigger.Filter.Shift
  |> HxTrigger.FromDocument
  |> HxTrigger.Delay "3s"
  |> _hxTrigger
  
  // or
  
  (HxTrigger.Filter.Shift >> HxTrigger.FromDocument >> HxTrigger.Delay "3s") HxTrigger.Click
  |> _hxTrigger
Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
Compatible target framework(s)
Additional computed target framework(s)
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.8.0 990 7/14/2022
1.7.0 872 2/24/2022
1.6.1 121 1/7/2022
0.9.2 238 11/11/2021
0.9.1 150 11/8/2021

Support new attributes/headers in htmx 1.8.0