freya-router 0.4.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
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

//! Routing
//!
//! High-level routing utilities for Freya applications. This crate provides
//! components like [Outlet](self::components::Outlet) and [Router](self::components::Router), hooks such as [use_route](self::hooks::use_route), and the
//! RouterContext to programmatically interact with navigation state.
//!
//! # Example
//!
//! A minimal router that switches between two routes. See `examples/feature_router.rs`
//! for a runnable demo.
//!
//! ```rust
//! use freya::{
//!     prelude::*,
//!     router::*,
//! };
//!
//! fn app() -> impl IntoElement {
//!     Router::<Route>::new(|| RouterConfig::default().with_initial_path(Route::Home))
//! }
//!
//! #[derive(PartialEq)]
//! struct Layout;
//! impl Component for Layout {
//!     fn render(&self) -> impl IntoElement {
//!         rect().center().expanded().child(Outlet::<Route>::new())
//!     }
//! }
//!
//! #[derive(PartialEq)]
//! struct Home;
//! impl Component for Home {
//!     fn render(&self) -> impl IntoElement {
//!         Link::new(Route::Settings).child("Go Settings")
//!     }
//! }
//!
//! #[derive(PartialEq)]
//! struct Settings;
//! impl Component for Settings {
//!     fn render(&self) -> impl IntoElement {
//!         Link::new(Route::Home).child("Go Home")
//!     }
//! }
//!
//! #[derive(Routable, Clone, PartialEq)]
//! #[rustfmt::skip]
//! pub enum Route {
//!     #[layout(Layout)]
//!         #[route("/")]
//!         Home,
//!         #[route("/settings")]
//!         Settings,
//! }
//! ```
// cannot use forbid, because props derive macro generates #[allow(missing_docs)]
#![allow(non_snake_case)]

mod memory;

pub mod navigation;
pub mod routable;

/// Components interacting with the router.
pub mod components {
    mod outlet;
    pub use outlet::*;

    mod router;
    pub use router::*;

    #[doc(hidden)]
    pub mod child_router;
}

mod contexts {
    pub(crate) mod outlet;
    pub use outlet::{
        OutletContext,
        use_outlet_context,
    };
    pub(crate) mod router;
    pub use router::{
        GenericRouterContext,
        ParseRouteError,
        RouterContext,
    };
}

mod router_cfg;

/// Hooks for interacting with the router in components.
pub mod hooks {
    mod use_route;
    pub use use_route::*;
}

/// A collection of useful items most applications might need.
pub mod prelude {
    pub use freya_router_macro::Routable;

    pub use crate::{
        components::{
            Outlet,
            Router,
            use_share_router,
        },
        contexts::*,
        hooks::*,
        memory::MemoryHistory,
        navigation::*,
        routable::*,
        router_cfg::RouterConfig,
    };
}

mod utils {
    pub(crate) mod use_router_internal;
}

#[doc(hidden)]
pub mod exports {
    pub use urlencoding;
}