finish router refrence
This commit is contained in:
1 parent
07446386e6
commit
b5a2f0d6cb
61 files changed
+676
-1908
No files matched your search
@@ -1,11 +1,11 @@
|
||||
# History Buttons
|
||||
|
||||
Some platforms, like web browsers, provide users with an easy way to navigate
|
||||
through an apps history. They have UI elements or integrate with the OS.
|
||||
through an app's history. They have UI elements or integrate with the OS.
|
||||
|
||||
However, native platforms usually don't provide such amenities, which means that
|
||||
apps wanting users to have access to them, need to implement them. For this
|
||||
reason the router comes with two components, which emulate a browsers back and
|
||||
reason, the router comes with two components, which emulate a browser's back and
|
||||
forward buttons:
|
||||
|
||||
- [`GoBackButton`](https://docs.rs/dioxus-router/latest/dioxus_router/components/fn.GoBackButton.html)
|
||||
@@ -14,38 +14,19 @@ forward buttons:
|
||||
> If you want to navigate through the history programmatically, take a look at
|
||||
> [`programmatic navigation`](./navigation/programmatic.md).
|
||||
|
||||
```rust, no_run, no_run
|
||||
# // Hidden lines (like this one) make the documentation tests work.
|
||||
# extern crate dioxus;
|
||||
use dioxus::prelude::*;
|
||||
# extern crate dioxus_router;
|
||||
use dioxus_router::prelude::*;
|
||||
|
||||
fn HistoryNavigation(cx: Scope) -> Element {
|
||||
render! {
|
||||
GoBackButton {
|
||||
"Back to the Past"
|
||||
}
|
||||
GoForwardButton {
|
||||
"Back to the Future" /* You see what I did there? 😉 */
|
||||
}
|
||||
}
|
||||
}
|
||||
```rust, no_run
|
||||
{{#include ../../examples/history_buttons.rs:history_buttons}}
|
||||
```
|
||||
|
||||
As you might know, browsers usually disable the back and forward buttons if
|
||||
there is no history to navigate to. The routers history buttons try to do that
|
||||
there is no history to navigate to. The router's history buttons try to do that
|
||||
too, but depending on the [history provider] that might not be possible.
|
||||
|
||||
Importantly, neither [`WebHistory`] nor [`WebHashHistory`] support that feature.
|
||||
Importantly, neither [`WebHistory`] supports that feature.
|
||||
This is due to limitations of the browser History API.
|
||||
|
||||
However, in both cases the router will just ignore button presses, if there is
|
||||
However, in both cases, the router will just ignore button presses, if there is
|
||||
no history to navigate to.
|
||||
|
||||
Also, when using [`WebHistory`] or [`WebHashHistory`], the history buttons might
|
||||
Also, when using [`WebHistory`], the history buttons might
|
||||
navigate a user to a history entry outside your app.
|
||||
|
||||
[history provider]: ./history-providers.md
|
||||
[`WebHistory`]: https://docs.rs/dioxus-router-core/latest/dioxus_router_core/history/struct.WebHistory.html
|
||||
[`WebHashHistory`]: https://docs.rs/dioxus-router-core/latest/dioxus_router_core/history/struct.WebHashHistory.html
|
||||
Reference in new issue
Block a user