mirror/axum-htmx
1
0
Fork 0
mirror of https://github.com/robertwayne/axum-htmx synced 2024-11-24 04:12:50 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Rob Wagner 2023-07-22 19:21:58 -04:00
parent dcb0c60172
commit a397d05e31
No known key found for this signature in database
GPG key ID: 53CCB4497B15CF61
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -9,6 +9,7 @@
<img src="https://img.shields.io/docsrs/axum-htmx?style=flat-square" alt="docs.rs badge"> <img src="https://img.shields.io/docsrs/axum-htmx?style=flat-square" alt="docs.rs badge">
</a> </a>
</div> </div>
<br>
<!-- markdownlint-enable --> <!-- markdownlint-enable -->
`axum-htmx` is a small extension library providing extractors for the various `axum-htmx` is a small extension library providing extractors for the various
@ -17,11 +18,9 @@
const values for all of the htmx headers, so there's no need to mess with const values for all of the htmx headers, so there's no need to mess with
strings in your handlers. strings in your handlers.
## Usage ## Getting Started
```toml Simply run `cargo add axum-htmx` to add the library to your project.
axum-htmx = { git = "https://github.com/robertwayne/axum-htmx", branch = "main" }
```
## Extractors ## Extractors
@ -41,7 +40,7 @@ present, the extractor will return `None` or `false` in most cases.
| `HX-Trigger-Name` | `HxTriggerName` | `Option<String>` | | `HX-Trigger-Name` | `HxTriggerName` | `Option<String>` |
| `HX-Trigger` | `HxTrigger` | `Option<String>` | | `HX-Trigger` | `HxTrigger` | `Option<String>` |
## Examples ## Example Usage
In this example, we'll look for the `HX-Boosted` header, which is set when In this example, we'll look for the `HX-Boosted` header, which is set when
applying the [hx-boost](https://htmx.org/attributes/hx-boost/) attribute to an applying the [hx-boost](https://htmx.org/attributes/hx-boost/) attribute to an