freya-router 0.5.0

Router management for Freya apps
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

use crate::prelude::Routable;

/// Configuration used when a [`Router`](crate::components::Router) is created.
///
/// By default, the router starts at `/`.
/// Use [`Self::with_initial_path`] to change the initial route.
///
/// ```rust,no_run
/// # use freya_router::prelude::*;
/// # use freya_core::prelude::*;
/// # #[derive(PartialEq)]
/// # struct Index;
/// # impl Component for Index {
/// #    fn render(&self) -> impl IntoElement {
/// #        rect()
/// #    }
/// # }
/// #[derive(Clone, Routable)]
/// enum Route {
///     #[route("/")]
///     Index {},
/// }
///
/// let cfg = RouterConfig::<Route>::default().with_initial_path(Route::Index {});
/// ```
pub struct RouterConfig<R: Routable> {
    pub(crate) initial_path: Option<R>,
}

impl<R: Routable> Default for RouterConfig<R> {
    fn default() -> Self {
        Self { initial_path: None }
    }
}

impl<R: Routable> RouterConfig<R> {
    /// Sets the route displayed when the router is first created.
    pub fn with_initial_path(mut self, initial_path: R) -> Self {
        self.initial_path = Some(initial_path);
        self
    }
}