This commit is contained in:
Evan Almloff committed 2023-06-02 12:33:47 -05:00
1 parent 577f99e68c
commit a9307e57e6
23 files changed
+160 -164

No files matched your search

@@ -24,8 +24,7 @@ pub struct GenericHistoryButtonProps<'a> {
/// ```rust
/// # use dioxus::prelude::*;
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// #[derive(Clone, Serialize, Deserialize, Routable)]
/// #[derive(Clone, Routable)]
/// enum Route {
/// #[route("/")]
/// Index {},
@@ -98,8 +97,7 @@ pub fn GenericGoBackButton<'a, R: Routable>(
/// ```rust
/// # use dioxus::prelude::*;
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// #[derive(Clone, Serialize, Deserialize, Routable)]
/// #[derive(Clone, Routable)]
/// enum Route {
/// #[route("/")]
/// Index {},
+1 -2
View File
@@ -83,9 +83,8 @@ impl<R: Routable> Debug for GenericLinkProps<'_, R> {
/// ```rust
/// # use dioxus::prelude::*;
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
///
/// #[derive(Clone, Serialize, Deserialize, Routable)]
/// #[derive(Clone, Routable)]
/// enum Route {
/// #[route("/")]
/// Index {},
+2 -6
View File
@@ -15,9 +15,8 @@ use dioxus::prelude::*;
/// # Example
/// ```rust
/// # use dioxus::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus_router::prelude::*;
/// #[derive(Clone, Serialize, Deserialize, Routable)]
/// #[derive(Clone, Routable)]
/// #[rustfmt::skip]
/// enum Route {
/// #[nest("/wrap")]
@@ -59,10 +58,7 @@ use dioxus::prelude::*;
/// # fn App(cx: Scope) -> Element {
/// # render! {
/// # Router {
/// # config: RouterConfiguration {
/// # history: Box::new(MemoryHistory::with_initial_path("/wrap").unwrap()),
/// # ..Default::default()
/// # }
/// # config: || RouterConfig::default().history(MemoryHistory::with_initial_path(Route::Child {}))
/// # }
/// # }
/// # }
+2 -15
View File
@@ -22,17 +22,6 @@ struct MutableRouterState<R>
where
R: Routable,
{
/// Whether there is a previous page to navigate back to.
///
/// Even if this is [`true`], there might not be a previous page. However, it is nonetheless
/// safe to tell the router to go back.
can_go_back: bool,
/// Whether there is a future page to navigate forward to.
///
/// Even if this is [`true`], there might not be a future page. However, it is nonetheless safe
/// to tell the router to go forward.
can_go_forward: bool,
/// The current prefix.
prefix: Option<String>,
@@ -76,8 +65,6 @@ where
R: Clone,
{
let state = Arc::new(RwLock::new(MutableRouterState {
can_go_back: false,
can_go_forward: false,
prefix: Default::default(),
history: cfg.history,
unresolved_error: None,
@@ -112,13 +99,13 @@ where
/// Check whether there is a previous page to navigate back to.
#[must_use]
pub fn can_go_back(&self) -> bool {
self.state.read().unwrap().can_go_back
self.state.read().unwrap().history.can_go_back()
}
/// Check whether there is a future page to navigate forward to.
#[must_use]
pub fn can_go_forward(&self) -> bool {
self.state.read().unwrap().can_go_forward
self.state.read().unwrap().history.can_go_forward()
}
/// Go back to the previous location.
+2 -3
View File
@@ -19,13 +19,12 @@ where
///
/// ```rust
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus::prelude::*;
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element { todo!() }
/// # #[inline_props]
/// # fn OtherPage(cx: Scope) -> Element { todo!() }
/// #[derive(Clone, Serialize, Deserialize, Routable, Debug, PartialEq)]
/// #[derive(Clone, Routable, Debug, PartialEq)]
/// enum Route {
/// #[route("/")]
/// Index {},
@@ -33,7 +32,7 @@ where
/// OtherPage {},
/// }
///
/// let mut history = MemoryHistory::<Route>::with_initial_path(Route::Index {}).unwrap();
/// let mut history = MemoryHistory::<Route>::with_initial_path(Route::Index {});
/// assert_eq!(history.current_route(), Route::Index {});
/// assert_eq!(history.can_go_back(), false);
/// ```
+7 -14
View File
@@ -47,13 +47,12 @@ pub trait HistoryProvider<R: Routable> {
///
/// ```rust
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus::prelude::*;
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element { todo!() }
/// # #[inline_props]
/// # fn OtherPage(cx: Scope) -> Element { todo!() }
/// #[derive(Clone, Serialize, Deserialize, Routable, Debug, PartialEq)]
/// #[derive(Clone, Routable, Debug, PartialEq)]
/// enum Route {
/// #[route("/")]
/// Index {},
@@ -86,11 +85,10 @@ pub trait HistoryProvider<R: Routable> {
///
/// ```rust
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus::prelude::*;
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element { todo!() }
/// #[derive(Clone, Serialize, Deserialize, Routable, Debug, PartialEq)]
/// #[derive(Clone, Routable, Debug, PartialEq)]
/// enum Route {
/// #[route("/")]
/// Index {},
@@ -113,13 +111,12 @@ pub trait HistoryProvider<R: Routable> {
///
/// ```rust
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus::prelude::*;
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element { todo!() }
/// # #[inline_props]
/// # fn OtherPage(cx: Scope) -> Element { todo!() }
/// #[derive(Clone, Serialize, Deserialize, Routable, Debug, PartialEq)]
/// #[derive(Clone, Routable, Debug, PartialEq)]
/// enum Route {
/// #[route("/")]
/// Index {},
@@ -146,13 +143,12 @@ pub trait HistoryProvider<R: Routable> {
///
/// ```rust
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus::prelude::*;
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element { todo!() }
/// # #[inline_props]
/// # fn OtherPage(cx: Scope) -> Element { todo!() }
/// #[derive(Clone, Serialize, Deserialize, Routable, Debug, PartialEq)]
/// #[derive(Clone, Routable, Debug, PartialEq)]
/// enum Route {
/// #[route("/")]
/// Index {},
@@ -180,13 +176,12 @@ pub trait HistoryProvider<R: Routable> {
///
/// ```rust
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus::prelude::*;
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element { todo!() }
/// # #[inline_props]
/// # fn OtherPage(cx: Scope) -> Element { todo!() }
/// #[derive(Clone, Serialize, Deserialize, Routable, Debug, PartialEq)]
/// #[derive(Clone, Routable, Debug, PartialEq)]
/// enum Route {
/// #[route("/")]
/// Index {},
@@ -214,13 +209,12 @@ pub trait HistoryProvider<R: Routable> {
///
/// ```rust
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus::prelude::*;
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element { todo!() }
/// # #[inline_props]
/// # fn OtherPage(cx: Scope) -> Element { todo!() }
/// #[derive(Clone, Serialize, Deserialize, Routable, Debug, PartialEq)]
/// #[derive(Clone, Routable, Debug, PartialEq)]
/// enum Route {
/// #[route("/")]
/// Index {},
@@ -244,13 +238,12 @@ pub trait HistoryProvider<R: Routable> {
///
/// ```rust
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus::prelude::*;
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element { todo!() }
/// # #[inline_props]
/// # fn OtherPage(cx: Scope) -> Element { todo!() }
/// #[derive(Clone, Serialize, Deserialize, Routable, Debug, PartialEq)]
/// #[derive(Clone, Routable, Debug, PartialEq)]
/// enum Route {
/// #[route("/")]
/// Index {},
+1 -2
View File
@@ -12,8 +12,7 @@ use crate::{
/// ```rust
/// # use dioxus::prelude::*;
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// #[derive(Clone, Serialize, Deserialize, Routable)]
/// #[derive(Clone, Routable)]
/// enum Route {
/// #[route("/")]
/// Index {},
+1 -2
View File
@@ -17,10 +17,9 @@ use crate::utils::use_router_internal::use_router_internal;
/// # Example
/// ```rust
/// # use dioxus::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus_router::{prelude::*};
///
/// #[derive(Clone, Serialize, Deserialize, Routable)]
/// #[derive(Clone, Routable)]
/// enum Route {
/// #[route("/")]
/// Index {},
+2 -4
View File
@@ -19,12 +19,11 @@ pub enum NavigationTarget<R: Routable> {
/// # use dioxus::prelude::*;
/// # use dioxus_router::prelude::*;
/// # use dioxus_router::navigation::NavigationTarget;
/// # use serde::{Deserialize, Serialize};
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element {
/// # todo!()
/// # }
/// #[derive(Clone, Serialize, Deserialize, Routable, PartialEq, Debug)]
/// #[derive(Clone, Routable, PartialEq, Debug)]
/// enum Route {
/// #[route("/")]
/// Index {},
@@ -40,12 +39,11 @@ pub enum NavigationTarget<R: Routable> {
/// # use dioxus::prelude::*;
/// # use dioxus_router::prelude::*;
/// # use dioxus_router::navigation::NavigationTarget;
/// # use serde::{Deserialize, Serialize};
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element {
/// # todo!()
/// # }
/// #[derive(Clone, Serialize, Deserialize, Routable, PartialEq, Debug)]
/// #[derive(Clone, Routable, PartialEq, Debug)]
/// enum Route {
/// #[route("/")]
/// Index {},
+2 -3
View File
@@ -12,18 +12,17 @@ use crate::prelude::*;
/// This implements [`Default`] and follows the builder pattern, so you can use it like this:
/// ```rust,no_run
/// # use dioxus_router::prelude::*;
/// # use serde::{Deserialize, Serialize};
/// # use dioxus::prelude::*;
/// # #[inline_props]
/// # fn Index(cx: Scope) -> Element {
/// # todo!()
/// # }
/// #[derive(Clone, Serialize, Deserialize, Routable)]
/// #[derive(Clone, Routable)]
/// enum Route {
/// #[route("/")]
/// Index {},
/// }
/// let cfg = RouterConfig::default().history(WebHistory<Route>::default());
/// let cfg = RouterConfig::default().history(WebHistory::<Route>::default());
/// ```
pub struct RouterConfig<R: Routable> {
pub(crate) failure_external_navigation: fn(Scope) -> Element,