yew-hooks 0.6.3

Hooks for the Yew web framework, inspired by react hook libs like streamich/react-use and alibaba/hooks.
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use gloo::utils::window;
use wasm_bindgen::JsValue;
use yew::prelude::*;

use super::use_event_with_window;

/// State for brower's location.
pub struct LocationState {
    pub trigger: String,
    pub state: Option<JsValue>,
    pub length: u32,
    pub hash: String,
    pub host: String,
    pub hostname: String,
    pub href: String,
    pub origin: String,
    pub pathname: String,
    pub port: String,
    pub protocol: String,
    pub search: String,
}

/// A sensor hook that tracks brower's location value.
///
/// # Example
///
/// ```rust
/// # use yew::prelude::*;
/// #
/// use yew_hooks::prelude::*;
///
/// #[function_component(UseLocation)]
/// fn location() -> Html {
///     let location = use_location();
///    
///     html! {
///         <>
///             <p>
///                 <b>{ "trigger: " }</b>
///                 { &location.trigger }
///             </p>
///             <p>
///                 <b>{ "state: " }</b>
///                 { format!("{:?}", &location.state) }
///             </p>
///             <p>
///                 <b>{ "length: " }</b>
///                 { &location.length }
///             </p>
///             <p>
///                 <b>{ "hash: " }</b>
///                 { &location.hash }
///             </p>
///             <p>
///                 <b>{ "host: " }</b>
///                 { &location.host }
///             </p>
///             <p>
///                 <b>{ "hostname: " }</b>
///                 { &location.hostname }
///             </p>
///             <p>
///                 <b>{ "href: " }</b>
///                 { &location.href }
///             </p>
///             <p>
///                 <b>{ "origin: " }</b>
///                 { &location.origin }
///             </p>
///             <p>
///                 <b>{ "pathname: " }</b>
///                 { &location.pathname }
///             </p>
///             <p>
///                 <b>{ "port: " }</b>
///                 { &location.port }
///             </p>
///             <p>
///                 <b>{ "protocol: " }</b>
///                 { &location.protocol }
///             </p>
///             <p>
///                 <b>{ "search: " }</b>
///                 { &location.search }
///             </p>
///         </>
///     }
/// }
/// ```
#[hook]
pub fn use_location() -> UseStateHandle<LocationState> {
    let state = use_state(|| build_location("load".to_string()));

    {
        let state = state.clone();
        use_event_with_window("popstate", move |_: Event| {
            state.set(build_location("popstate".to_string()));
        });
    }

    {
        let state = state.clone();
        use_event_with_window("pushstate", move |_: Event| {
            state.set(build_location("pushstate".to_string()));
        });
    }

    {
        let state = state.clone();
        use_event_with_window("replacestate", move |_: Event| {
            state.set(build_location("replacestate".to_string()));
        });
    }

    state
}

fn build_location(trigger: String) -> LocationState {
    let location = window().location();
    let history = window().history().map_or((None, 0), |history| {
        (
            history.state().ok(),
            history.length().map_or(0, |length| length),
        )
    });

    LocationState {
        trigger,
        state: history.0,
        length: history.1,
        hash: location.hash().unwrap_or_default(),
        host: location.host().unwrap_or_default(),
        hostname: location.hostname().unwrap_or_default(),
        href: location.href().unwrap_or_default(),
        origin: location.origin().unwrap_or_default(),
        pathname: location.pathname().unwrap_or_default(),
        port: location.port().unwrap_or_default(),
        protocol: location.protocol().unwrap_or_default(),
        search: location.search().unwrap_or_default(),
    }
}