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
//! # Routing
//!
//! Declarative, in-memory routing for Freya applications. Define a route enum with
//! `#[derive(Routable)]`, mount a [Router](components::Router), and render the
//! active page with an [Outlet](components::Outlet).
//!
//! Enable Freya's `router` feature and import the reexport with
//! `use freya::router::*;`. `freya::components::Link` provides declarative
//! navigation. Use [RouterContext](prelude::RouterContext) for navigation from event
//! handlers and other imperative code in a component.
//!
//! # Navigation
//!
//! `Link::new(Route::Settings)` pushes an internal route when pressed. To navigate
//! in an event handler, obtain the context in an event handler and
//! call [`RouterContext::push`](prelude::RouterContext::push) or
//! [`RouterContext::replace`](prelude::RouterContext::replace).
//!
//! ```rust,no_run
//! # use freya::{components::Button, prelude::*, router::*};
//! # #[derive(PartialEq)]
//! # struct Home;
//! # impl Component for Home {
//! # fn render(&self) -> impl IntoElement { "Home" }
//! # }
//! # #[derive(PartialEq)]
//! # struct Settings;
//! # impl Component for Settings {
//! # fn render(&self) -> impl IntoElement {
//! let router = RouterContext::get();
//! Button::new()
//! .on_press(move |_| {
//! let _ = router.push(Route::Home);
//! })
//! .child("Save")
//! # }
//! # }
//! # #[derive(Routable, Clone, PartialEq)]
//! # enum Route { #[route("/")] Home, #[route("/settings")] Settings }
//! ```
//!
//! Use `freya::components::NativeRouterExt` with `rect().native_router()` to
//! handle native back and forward mouse buttons.
//!
//! See the [basic router example](https://github.com/marc2332/freya/blob/main/examples/feature_router.rs),
//! [nested routes and history example](https://github.com/marc2332/freya/blob/main/examples/feature_router_complex.rs),
//! and [shared multi-window router example](https://github.com/marc2332/freya/blob/main/examples/feature_multi_window_router.rs).
//!
//! # Example
//!
//! A minimal router that switches between two routes.
//!
//! ```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)]
/// Components interacting with the router.
/// Hooks for interacting with the router in components.
/// A collection of useful items most applications might need.