leptos_router 0.8.13

Router for the Leptos web framework.
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use crate::{
    location::Location,
    matching::Params,
    route::MatchedRoute,
    router::{FallbackOrView, Router},
    static_render::StaticDataMap,
    PathSegment, RouteList, RouteListing, SsrMode,
};
use reactive_graph::{
    memo::Memo,
    signal::ArcRwSignal,
    traits::{SignalGet, SignalSet, SignalWith, Track},
    untrack, Owner,
};
use std::{marker::PhantomData, mem};
use tachydom::{
    hydration::Cursor,
    log,
    renderer::Renderer,
    ssr::StreamBuilder,
    view::{Mountable, Position, PositionState, Render, RenderHtml},
};

#[allow(non_snake_case)]
pub fn ReactiveRouter<Rndr, Loc, DefFn, Defs, FallbackFn, Fallback>(
    mut location: Loc,
    routes: DefFn,
    fallback: FallbackFn,
) -> impl RenderHtml
where
    DefFn: Fn() -> Defs + 'static,
    Defs: 'static,
    Loc: Location + Clone + 'static,
    Rndr: Renderer + 'static,
    Rndr::Element: Clone,
    Rndr::Node: Clone,
    FallbackFn: Fn() -> Fallback + Clone + 'static,
    Fallback: Render + 'static,
    Router<Rndr, Loc, Defs, FallbackFn>: FallbackOrView,
    <Router<Rndr, Loc, Defs, FallbackFn> as FallbackOrView>::Output: RenderHtml,
{
    // create a reactive URL signal that will drive the router view
    let url = ArcRwSignal::new(location.try_to_url().unwrap_or_default());

    // initialize the location service with a router hook that will update
    // this URL signal
    location.set_navigation_hook({
        let url = url.clone();
        move |new_url| {
            tachydom::log(&format!("setting url to {new_url:?}"));
            url.set(new_url)
        }
    });
    location.init();

    // return a reactive router that will update if and only if the URL signal changes
    let owner = Owner::current().unwrap();
    move || {
        url.track();
        ReactiveRouterInner {
            owner: owner.clone(),
            inner: Router::new(location.clone(), routes(), fallback.clone()),
            fal: PhantomData,
        }
    }
}

struct ReactiveRouterInner<Rndr, Loc, Defs, FallbackFn, Fallback>
where
    Rndr: Renderer,
{
    owner: Owner,
    inner: Router<Rndr, Loc, Defs, FallbackFn>,
    fal: PhantomData<Fallback>,
}

impl<Rndr, Loc, Defs, FallbackFn, Fallback> Render
    for ReactiveRouterInner<Rndr, Loc, Defs, FallbackFn, Fallback>
where
    Loc: Location,
    Rndr: Renderer,
    Rndr::Element: Clone,
    Rndr::Node: Clone,
    FallbackFn: Fn() -> Fallback,
    Fallback: Render,
    Router<Rndr, Loc, Defs, FallbackFn>: FallbackOrView,
    <Router<Rndr, Loc, Defs, FallbackFn> as FallbackOrView>::Output: Render,
{
    type State =
        ReactiveRouterInnerState<Rndr, Loc, Defs, FallbackFn, Fallback>;

    fn build(self) -> Self::State {
        let (prev_id, inner) = self.inner.fallback_or_view();
        let owner = self.owner.with(Owner::new);
        ReactiveRouterInnerState {
            inner: owner.with(|| inner.build()),
            owner,
            prev_id,
            fal: PhantomData,
        }
    }

    fn rebuild(self, state: &mut Self::State) {
        let (new_id, view) = self.inner.fallback_or_view();
        if new_id != state.prev_id {
            state.owner = self.owner.with(Owner::new)
            // previous root is dropped here -- TODO check if that's correct or should wait
        };
        state.owner.with(|| view.rebuild(&mut state.inner));
    }
}

impl<Rndr, Loc, Defs, FallbackFn, Fallback> RenderHtml
    for ReactiveRouterInner<Rndr, Loc, Defs, FallbackFn, Fallback>
where
    Loc: Location,
    Rndr: Renderer,
    Rndr::Element: Clone,
    Rndr::Node: Clone,
    FallbackFn: Fn() -> Fallback,
    Fallback: Render,
    Router<Rndr, Loc, Defs, FallbackFn>: FallbackOrView,
    <Router<Rndr, Loc, Defs, FallbackFn> as FallbackOrView>::Output: RenderHtml,
{
    const MIN_LENGTH: usize = <<Router<Rndr, Loc, Defs, FallbackFn> as FallbackOrView>::Output as RenderHtml>::MIN_LENGTH;

    fn to_html_with_buf(
        self,
        buf: &mut String,
        position: &mut Position,
        escape: bool,
        mark_branches: bool, extra_attrs: Vec<AnyAttribute>) {
        // if this is being run on the server for the first time, generating all possible routes
        if RouteList::is_generating() {
            let mut routes = RouteList::new();

            // add routes
            self.inner.generate_route_list(&mut routes);

            // add fallback
            routes.push(RouteListing::from_path([PathSegment::Static(
                "".into(),
            )]));

            RouteList::register(routes);
        } else {
            let (id, view) = self.inner.fallback_or_view();
            view.to_html_with_buf(buf, position, escape)
        }
    }

    fn to_html_async_with_buf<const OUT_OF_ORDER: bool>(
        self,
        buf: &mut StreamBuilder,
        position: &mut Position,
        escape: bool,
        mark_branches: bool, extra_attrs: Vec<AnyAttribute>) where
        Self: Sized,
    {
        self.inner
            .fallback_or_view()
            .1
            .to_html_async_with_buf::<OUT_OF_ORDER>(buf, position, escape)
    }

    fn hydrate<const FROM_SERVER: bool>(
        self,
        cursor: &Cursor,
        position: &PositionState,
    ) -> Self::State {
        let (prev_id, inner) = self.inner.fallback_or_view();
        let owner = self.owner.with(Owner::new);
        ReactiveRouterInnerState {
            inner: owner
                .with(|| inner.hydrate::<FROM_SERVER>(cursor, position)),
            owner,
            prev_id,
            fal: PhantomData,
        }
    }
}

struct ReactiveRouterInnerState<Rndr, Loc, Defs, FallbackFn, Fallback>
where
    Router<Rndr, Loc, Defs, FallbackFn>: FallbackOrView,
    <Router<Rndr, Loc, Defs, FallbackFn> as FallbackOrView>::Output: Render,
    Rndr: Renderer,
{
    owner: Owner,
    prev_id: &'static str,
    inner: <<Router<Rndr, Loc, Defs, FallbackFn> as FallbackOrView>::Output as Render>::State,
    fal: PhantomData<Fallback>,
}

impl<Rndr, Loc, Defs, FallbackFn, Fallback> Mountable
    for ReactiveRouterInnerState<Rndr, Loc, Defs, FallbackFn, Fallback>
where
    Router<Rndr, Loc, Defs, FallbackFn>: FallbackOrView,
    <Router<Rndr, Loc, Defs, FallbackFn> as FallbackOrView>::Output: Render,
    Rndr: Renderer,
{
    fn unmount(&mut self) {
        self.inner.unmount();
    }

    fn mount(
        &mut self,
        parent: &leptos::tachys::renderer::types::Element,
        marker: Option<&leptos::tachys::renderer::types::Node>,
    ) {
        self.inner.mount(parent, marker);
    }

    fn insert_before_this(&self, child: &mut dyn Mountable) -> bool {
        self.inner.insert_before_this(child)
    }
}

pub struct ReactiveMatchedRoute {
    pub(crate) search_params: ArcRwSignal<Params<String>>,
    pub(crate) params: ArcRwSignal<Params<&'static str>>,
    pub(crate) matched: ArcRwSignal<String>,
}

impl ReactiveMatchedRoute {
    pub fn param(&self, key: &str) -> Memo<Option<String>> {
        let params = self.params.clone();
        let key = key.to_owned();
        Memo::new(move |_| {
            params.with(|p| {
                p.iter().find(|n| n.0 == key).map(|(_, v)| v.to_string())
            })
        })
    }

    pub fn search(&self, key: &str) -> Memo<Option<String>> {
        let params = self.search_params.clone();
        let key = key.to_owned();
        Memo::new(move |_| {
            params.with(|p| {
                p.iter().find(|n| n.0 == key).map(|(_, v)| v.to_string())
            })
        })
    }
}

pub fn reactive_route<ViewFn, View>(
    view_fn: ViewFn,
) -> impl Fn(MatchedRoute) -> ReactiveRoute<ViewFn, View>
where
    ViewFn: Fn(&ReactiveMatchedRoute) -> View + Clone,
    View: Render,
    Rndr: Renderer,
{
    move |matched| ReactiveRoute {
        view_fn: view_fn.clone(),
        matched,
        ty: PhantomData,
    }
}

pub struct ReactiveRoute<ViewFn, View>
where
    ViewFn: Fn(&ReactiveMatchedRoute) -> View,
    View: Render,
    Rndr: Renderer,
{
    view_fn: ViewFn,
    matched: MatchedRoute,
    ty: PhantomData,
}

impl<ViewFn, View> Render for ReactiveRoute<ViewFn, View>
where
    ViewFn: Fn(&ReactiveMatchedRoute) -> View,
    View: Render,
    Rndr: Renderer,
{
    type State = ReactiveRouteState<View::State>;

    fn build(self) -> Self::State {
        let MatchedRoute {
            search_params,
            params,
            matched,
        } = self.matched;
        let matched = ReactiveMatchedRoute {
            search_params: ArcRwSignal::new(search_params),
            params: ArcRwSignal::new(params),
            matched: ArcRwSignal::new(matched),
        };
        let view_state = untrack(|| (self.view_fn)(&matched).build());
        ReactiveRouteState {
            matched,
            view_state,
        }
    }

    fn rebuild(mut self, state: &mut Self::State) {
        let ReactiveRouteState { matched, .. } = state;
        matched
            .search_params
            .set(mem::take(&mut self.matched.search_params));
        matched.params.set(mem::take(&mut self.matched.params));
        matched.matched.set(mem::take(&mut self.matched.matched));
    }
}

impl<ViewFn, View> RenderHtml for ReactiveRoute<ViewFn, View>
where
    ViewFn: Fn(&ReactiveMatchedRoute) -> View,
    View: RenderHtml,
    Rndr: Renderer,
    Rndr::Node: Clone,
    Rndr::Element: Clone,
{
    const MIN_LENGTH: usize = 0;

    fn to_html_with_buf(
        self,
        buf: &mut String,
        position: &mut Position,
        escape: bool,
        mark_branches: bool, extra_attrs: Vec<AnyAttribute>) {
        let MatchedRoute {
            search_params,
            params,
            matched,
        } = self.matched;
        let matched = ReactiveMatchedRoute {
            search_params: ArcRwSignal::new(search_params),
            params: ArcRwSignal::new(params),
            matched: ArcRwSignal::new(matched),
        };
        untrack(|| {
            (self.view_fn)(&matched).to_html_with_buf(buf, position, escape)
        });
    }

    fn to_html_async_with_buf<const OUT_OF_ORDER: bool>(
        self,
        buf: &mut StreamBuilder,
        position: &mut Position,
        escape: bool,
        mark_branches: bool, extra_attrs: Vec<AnyAttribute>) where
        Self: Sized,
    {
        let MatchedRoute {
            search_params,
            params,
            matched,
        } = self.matched;
        let matched = ReactiveMatchedRoute {
            search_params: ArcRwSignal::new(search_params),
            params: ArcRwSignal::new(params),
            matched: ArcRwSignal::new(matched),
        };
        untrack(|| {
            (self.view_fn)(&matched)
                .to_html_async_with_buf::<OUT_OF_ORDER>(buf, position, escape)
        });
    }

    fn hydrate<const FROM_SERVER: bool>(
        self,
        cursor: &Cursor,
        position: &PositionState,
    ) -> Self::State {
        let MatchedRoute {
            search_params,
            params,
            matched,
        } = self.matched;
        let matched = ReactiveMatchedRoute {
            search_params: ArcRwSignal::new(search_params),
            params: ArcRwSignal::new(params),
            matched: ArcRwSignal::new(matched),
        };
        let view_state = untrack(|| {
            (self.view_fn)(&matched).hydrate::<FROM_SERVER>(cursor, position)
        });
        ReactiveRouteState {
            matched,
            view_state,
        }
    }
}

pub struct ReactiveRouteState<State> {
    view_state: State,
    matched: ReactiveMatchedRoute,
}

impl<State> Drop for ReactiveRouteState<State> {
    fn drop(&mut self) {
        log("dropping ReactiveRouteState");
    }
}

impl<T> Mountable for ReactiveRouteState<T>
where
    T: Mountable,
{
    fn unmount(&mut self) {
        self.view_state.unmount();
    }

    fn mount(
        &mut self,
        parent: &<R as Renderer>::Element,
        marker: Option<&<R as Renderer>::Node>,
    ) {
        self.view_state.mount(parent, marker);
    }

    fn insert_before_this(&self, child: &mut dyn Mountable) -> bool {
        self.view_state.insert_before_this(child)
    }
}