mirror/axum-htmx
1
0
Fork 0
mirror of https://github.com/robertwayne/axum-htmx synced 2024-12-27 18:59:32 +01:00
Code Issues Projects Releases Packages Wiki Activity

Updated README with better explanation of hx_boosted_by usage

Browse source
This commit is contained in:
Dan Alekseev 2024-04-07 14:19:54 +04:00
parent f941f00e34
commit 09c129fcf7
1 changed files with 14 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -96,6 +96,14 @@ __Requires features `derive`.__
In addition to the HxBoosted extractor, the library provides macroses `hx_boosted_by` and it's async version `hx_boosted_by_async` for managing the response based on the presence of the `HX-Boosted` header. In addition to the HxBoosted extractor, the library provides macroses `hx_boosted_by` and it's async version `hx_boosted_by_async` for managing the response based on the presence of the `HX-Boosted` header.
The macro input should have a `layout_fn` and can have arguments passed from annotated function into `layout_fn`. The macro will call the layout_fn with if the `HX-Boosted` header is not present, otherwise it will return the response directly.
```rust
#[hx_boosted_by(layout_fn, [arg1, agr2, ...])]
```
If `layout_fn` is an async function, use `hx_boosted_by_async` instead.
## Examples ## Examples
### Example: Extractors ### Example: Extractors
@ -197,18 +205,20 @@ fn router_two() -> Router {
```rust ```rust
use axum_htmx::hx_boosted_by; use axum_htmx::hx_boosted_by;
#[hx_boosted_by(with_layout)] #[hx_boosted_by(with_layout, page_title)]
async fn get_hello(Path(name): Path<String>) -> Html<String> { async fn get_hello(Path(name): Path<String>) -> Html<String> {
let page_title = "Hello Page";
Html(format!("Hello, {}!", name)) Html(format!("Hello, {}!", name))
} }
#[hx_boosted_by(with_layout)] #[hx_boosted_by(with_layout, page_title)]
async fn get_bye(Path(name): Path<String>) -> Html<String> { async fn get_bye(Path(name): Path<String>) -> Html<String> {
let page_title = "Bye Page";
Html(format!("Bye, {}!", name)) Html(format!("Bye, {}!", name))
} }
fn with_layout(Html(partial): Html<String>) -> Html<String> { fn with_layout(Html(partial): Html<String>, page_title: &str) -> Html<String> {
Html(format!("<html><body>{}</body></html>", partial)) Html(format!("<html><head><title>{}</title></head><body>{}</body></html>", page_title, partial))
} }
``` ```