axum-htmx 0.8.1

A set of htmx extractors, responders, and request guards for axum.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//! HTTP headers used by htmx.

use http::HeaderName;

/// Indicates that the request is via an element using `hx-boost` attribute.
///
/// See <https://htmx.org/attributes/hx-boost/> for more information.
pub const HX_BOOSTED: HeaderName = HeaderName::from_static("hx-boosted");

/// The current URL of the browser.
pub const HX_CURRENT_URL: HeaderName = HeaderName::from_static("hx-current-url");

/// `true` if the request is for history restoration after a miss in the local
/// history cache.
pub const HX_HISTORY_RESTORE_REQUEST: HeaderName =
    HeaderName::from_static("hx-history-restore-request");

/// The user response to an `hx-prompt`
///
/// See <https://htmx.org/attributes/hx-prompt/> for more information.
pub const HX_PROMPT: HeaderName = HeaderName::from_static("hx-prompt");

pub(crate) const HX_REQUEST_STR: &str = "hx-request";

/// Always `true`.
pub const HX_REQUEST: HeaderName = HeaderName::from_static(HX_REQUEST_STR);

pub(crate) const HX_TARGET_STR: &str = "hx-target";

/// The `id` of the target element, if it exists.
pub const HX_TARGET: HeaderName = HeaderName::from_static(HX_TARGET_STR);

pub(crate) const HX_TRIGGER_NAME_STR: &str = "hx-trigger-name";

/// The `name` of the triggered element, if it exists.
pub const HX_TRIGGER_NAME: HeaderName = HeaderName::from_static(HX_TRIGGER_NAME_STR);

/// Allows you to do a client-side redirect that does not do a full page reload.
pub const HX_LOCATION: HeaderName = HeaderName::from_static("hx-location");

/// Pushes a new URL onto the history stack.
pub const HX_PUSH_URL: HeaderName = HeaderName::from_static("hx-push-url");

/// Can be used to do a client-side redirect to a new location.
pub const HX_REDIRECT: HeaderName = HeaderName::from_static("hx-redirect");

/// If set to `true`, the client will do a full refresh on the page.
pub const HX_REFRESH: HeaderName = HeaderName::from_static("hx-refresh");

/// Replaces the currelt URL in the location bar.
pub const HX_REPLACE_URL: HeaderName = HeaderName::from_static("hx-replace-url");

/// Allows you to specify how the response value will be swapped.
///
/// See <https://htmx.org/attributes/hx-swap/> for more information.
pub const HX_RESWAP: HeaderName = HeaderName::from_static("hx-reswap");

/// A CSS selector that update the target of the content update to a different
/// element on the page.
pub const HX_RETARGET: HeaderName = HeaderName::from_static("hx-retarget");

/// A CSS selector that allows you to choose which part of the response is used
/// to be swapped in. Overrides an existing `hx-select` on the triggering
/// element
pub const HX_RESELECT: HeaderName = HeaderName::from_static("hx-reselect");

pub(crate) const HX_TRIGGER_STR: &str = "hx-trigger";

/// Can be set as a request or response header.
///
/// In a request, it contains the `id` of the element that triggered the
/// request.
///
/// In a response, it can be used to trigger client-side events.
///
/// See <https://htmx.org/headers/hx-trigger/> for more information.
pub const HX_TRIGGER: HeaderName = HeaderName::from_static(HX_TRIGGER_STR);

/// Allows you to trigger client-side events.
///
/// See <https://htmx.org/headers/hx-trigger/> for more information.
pub const HX_TRIGGER_AFTER_SETTLE: HeaderName = HeaderName::from_static("hx-trigger-after-settle");

/// Allows you to trigger client-side events.
///
/// See <https://htmx.org/headers/hx-trigger/> for more information.
pub const HX_TRIGGER_AFTER_SWAP: HeaderName = HeaderName::from_static("hx-trigger-after-swap");