From 4be5bad8efeb576861394d37a6cfce2d70cd70ba Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Thu, 14 Jul 2022 09:24:49 -0400 Subject: [PATCH] Update package READMEs --- src/Htmx/README.md | 6 ++++-- src/ViewEngine.Htmx/README.md | 4 ++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/Htmx/README.md b/src/Htmx/README.md index c1b95c7..21b550e 100644 --- a/src/Htmx/README.md +++ b/src/Htmx/README.md @@ -2,7 +2,7 @@ This package enables server-side support for [htmx](https://htmx.org) within [Giraffe](https://giraffe.wiki) and ASP.NET's `HttpContext`. -**htmx version: 1.7.0** +**htmx version: 1.8.0** ### Setup @@ -27,9 +27,11 @@ To set a response header: let myHandler : HttpHander = fun next ctx -> // some meaningful work - withHxPush "/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. + ### 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. \ No newline at end of file diff --git a/src/ViewEngine.Htmx/README.md b/src/ViewEngine.Htmx/README.md index 6314948..b3e9ad7 100644 --- a/src/ViewEngine.Htmx/README.md +++ b/src/ViewEngine.Htmx/README.md @@ -2,7 +2,7 @@ This package enables [htmx](https://htmx.org) support within the [Giraffe](https://giraffe.wiki) view engine. -**htmx version: 1.7.0** +**htmx version: 1.8.0** ### Setup @@ -23,7 +23,7 @@ Support modules include: - `HxHeaders` - `HxParams` - `HxRequest` -- `HxSwap` +- `HxSwap` (requires `open Giraffe.Htmx`) - `HxTrigger` - `HxVals`