diff --git a/README.md b/README.md index 3490494..80a3423 100644 --- a/README.md +++ b/README.md @@ -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... ```fsharp - // "partial" and "full" are handlers that return the contents; - // "view" can be whatever your view engine needs for the body of the page - let result view : HttpHandler = +// "partial" and "full" are handlers that return the contents; +// "view" can be whatever your view engine needs for the body of the page +let result view : HttpHandler = fun next ctx -> - match ctx.Request.IsHtmx && not ctx.Request.IsHtmxRefresh with - | true -> partial view - | false -> full view + if ctx.Request.IsHtmx && not ctx.Request.IsHtmxRefresh then + partial 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. ```fsharp - let theHandler : HttpHandler = +let theHandler : HttpHandler = fun next ctx -> - // some interesting stuff - withHxRedirect "/the-new-url" >=> Successful.OK + // some interesting stuff + 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. @@ -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: ```fsharp - let autoload = - div [ _hxGet "/lazy-load-data"; _hxTrigger "load" ] [ str "Loading..." ] +let autoload = + 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.)_ @@ -57,10 +60,10 @@ _(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. ```fsharp - let shiftClick = +let shiftClick = 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. diff --git a/src/Common/README.md b/src/Common/README.md index bd7ea51..463389a 100644 --- a/src/Common/README.md +++ b/src/Common/README.md @@ -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. -**htmx version: 1.9.11** +**htmx version: 2.0.0-beta1** diff --git a/src/Directory.Build.props b/src/Directory.Build.props index ca23561..778d6a4 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -2,8 +2,9 @@ net6.0;net7.0;net8.0 - 1.9.11 - Update script tags to pull htmx 1.9.11 + 2.0.0 + beta1 + Update script tags to pull htmx 2.0.0-beta1 danieljsummers Bit Badger Solutions https://github.com/bit-badger/Giraffe.Htmx @@ -12,6 +13,6 @@ Git MIT License MIT - Giraffe htmx + Giraffe htmx beta diff --git a/src/Htmx/README.md b/src/Htmx/README.md index 4c93fd3..afb5d03 100644 --- a/src/Htmx/README.md +++ b/src/Htmx/README.md @@ -2,11 +2,13 @@ This package enables server-side support for [htmx](https://htmx.org) within [Giraffe](https://giraffe.wiki) and ASP.NET's `HttpContext`. -**htmx version: 1.9.11** +**htmx version: 2.0.0-beta1** + +_Note that htmx 2.0 is a BETA release. The [migration guide](https://v2-0v2-0.htmx.org/migration-guide-htmx-1/) 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. +1. Install the package (must use `--Prerelease` flag). 2. Prior to using the request header extension properties or the header-setting `HttpHandler`s, `open Giraffe.Htmx`. ### Use @@ -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: ```fsharp - let myHandler : HttpHander = +let myHandler : HttpHander = fun next ctx -> - match ctx.HxPrompt with - | Some prompt -> ... // do something with the text the user provided - | None -> ... // no text provided + 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 = +let myHandler : HttpHander = fun next ctx -> - // some meaningful work - withHxPushUrl "/some/new/url" >=> [other handlers] + // 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. diff --git a/src/Tests/ViewEngine.fs b/src/Tests/ViewEngine.fs index d242c72..7d6ed37 100644 --- a/src/Tests/ViewEngine.fs +++ b/src/Tests/ViewEngine.fs @@ -820,14 +820,14 @@ let script = let html = RenderView.AsString.htmlNode Script.minified Expect.equal html - """""" + """""" "Minified script tag is incorrect" } test "unminified succeeds" { let html = RenderView.AsString.htmlNode Script.unminified Expect.equal html - """""" + """""" "Unminified script tag is incorrect" } ] @@ -979,18 +979,6 @@ let renderFragment = ] ] -#nowarn "44" - -/// Tests for the HtmxAttrs module -let deprecatedAttributes = - testList "Deprecated Attributes" [ - test "_hxOn succeeds" { - let newLine = "\n" - strong [ _hxOn "submit: alert('oops')\nclick: alert('howdy!')" ] [] - |> shouldRender $"""""" - } - ] - /// All tests in this module let allTests = testList "ViewEngine.Htmx" [ @@ -1004,5 +992,4 @@ let allTests = attributes script renderFragment - deprecatedAttributes ] diff --git a/src/ViewEngine.Htmx/Htmx.fs b/src/ViewEngine.Htmx/Htmx.fs index cb3461e..fbfd349 100644 --- a/src/ViewEngine.Htmx/Htmx.fs +++ b/src/ViewEngine.Htmx/Htmx.fs @@ -317,8 +317,6 @@ module HxVals = /// Create values from a list of key/value pairs let From = toJson -open System - /// Attributes and flags for htmx [] module HtmxAttrs = @@ -368,10 +366,6 @@ module HtmxAttrs = /// Overrides a previous `hx-boost` let _hxNoBoost = attr "hx-boost" "false" - /// Attach an event handler for DOM or htmx events - [] - let _hxOn = attr "hx-on" - /// Attach an event handler for DOM events let _hxOnEvent evtName = attr $"hx-on:%s{evtName}" @@ -450,14 +444,14 @@ module Script = /// Script tag to load the minified version from unpkg.com let minified = - script [ _src "https://unpkg.com/htmx.org@1.9.11" - _integrity "sha384-0gxUXCCR8yv9FM2b+U3FDbsKthCI66oH5IA9fHppQq9DDMHuMauqq1ZHBpJxQ0J0" + script [ _src "https://unpkg.com/htmx.org@2.0.0-beta1" + _integrity "sha384-T4bn1KcRXtR+kI4M+oOdhVp039Q5Oyq59dsDYJuSBCuHDbLA4iBpCSYaEKmGK5AU" _crossorigin "anonymous" ] [] /// Script tag to load the unminified version from unpkg.com let unminified = - script [ _src "https://unpkg.com/htmx.org@1.9.11/dist/htmx.js" - _integrity "sha384-l9bYT9SL4CAW0Hl7pAOpfRc18mys1b0wK4U8UtGnWOxPVbVMgrOdB+jyz/WY8Jue" + script [ _src "https://unpkg.com/htmx.org@2.0.0-beta1/dist/htmx.js" + _integrity "sha384-LT44Cr6uyeKreQr6d0kPh+o3cuLJ3Q+ysV1YzehXD6D9pdpF/7DMiUDx7hrlPiNi" _crossorigin "anonymous" ] [] diff --git a/src/ViewEngine.Htmx/README.md b/src/ViewEngine.Htmx/README.md index eef4e92..0fc008a 100644 --- a/src/ViewEngine.Htmx/README.md +++ b/src/ViewEngine.Htmx/README.md @@ -2,11 +2,13 @@ This package enables [htmx](https://htmx.org) support within the [Giraffe](https://giraffe.wiki) view engine. -**htmx version: 1.9.11** +**htmx version: 2.0.0-beta1** + +_Note that this is a BETA release of htmx 2.0; see [the migration guide](https://v2-0v2-0.htmx.org/migration-guide-htmx-1/) for changes_ ### Setup -1. Install the package. +1. Install the package (must use `--Prelease` flag). 2. Prior to using the attribute or support modules, `open Giraffe.ViewEngine.Htmx`. ### Use @@ -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: ```fsharp - let autoload = +let autoload = div [ _hxGet "/this/data"; _hxTrigger HxTrigger.Load ] [ str "Loading..." ] ``` @@ -43,19 +45,19 @@ The support modules contain named properties for known values (as illustrated wi - `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 +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 +HxTrigger.Click +|> HxTrigger.Filter.Shift +|> HxTrigger.FromDocument +|> HxTrigger.Delay "3s" +|> _hxTrigger + +// or + +(HxTrigger.Filter.Shift >> HxTrigger.FromDocument >> HxTrigger.Delay "3s") HxTrigger.Click +|> _hxTrigger ```