153 lines
3.9 KiB
Rust
153 lines
3.9 KiB
Rust
use dioxus_lib::prelude::*;
|
|
|
|
use tracing::error;
|
|
|
|
use crate::utils::use_router_internal::use_router_internal;
|
|
|
|
/// The properties for a [`GoBackButton`] or a [`GoForwardButton`].
|
|
#[derive(Debug, Props, Clone, PartialEq)]
|
|
pub struct HistoryButtonProps {
|
|
/// The children to render within the generated HTML button tag.
|
|
pub children: Element,
|
|
}
|
|
|
|
/// A button to go back through the navigation history. Similar to a browsers back button.
|
|
///
|
|
/// Only works as descendant of a [`Link`] component, otherwise it will be inactive.
|
|
///
|
|
/// The button will disable itself if it is known that no prior history is available.
|
|
///
|
|
/// # Panic
|
|
/// - When the [`GoBackButton`] is not nested within a [`Link`] component
|
|
/// hook, but only in debug builds.
|
|
///
|
|
/// # Example
|
|
/// ```rust
|
|
/// # use dioxus::prelude::*;
|
|
/// # use dioxus_router::prelude::*;
|
|
/// #[derive(Clone, Routable)]
|
|
/// enum Route {
|
|
/// #[route("/")]
|
|
/// Index {},
|
|
/// }
|
|
///
|
|
/// #[component]
|
|
/// fn App() -> Element {
|
|
/// rsx! {
|
|
/// Router::<Route> {}
|
|
/// }
|
|
/// }
|
|
///
|
|
/// #[component]
|
|
/// fn Index() -> Element {
|
|
/// rsx! {
|
|
/// GoBackButton {
|
|
/// "go back"
|
|
/// }
|
|
/// }
|
|
/// }
|
|
/// #
|
|
/// # let mut vdom = VirtualDom::new(App);
|
|
/// # let _ = vdom.rebuild();
|
|
/// # assert_eq!(
|
|
/// # dioxus_ssr::render(&vdom),
|
|
/// # r#"<button disabled="true" dioxus-prevent-default="onclick">go back</button>"#
|
|
/// # );
|
|
/// ```
|
|
#[component]
|
|
pub fn GoBackButton(
|
|
/// The props...
|
|
mut props: HistoryButtonProps,
|
|
) -> Element {
|
|
let HistoryButtonProps { children } = props;
|
|
|
|
// hook up to router
|
|
let router = match use_router_internal() {
|
|
Some(r) => r,
|
|
#[allow(unreachable_code)]
|
|
None => {
|
|
let msg = "`GoBackButton` must have access to a parent router";
|
|
error!("{msg}, will be inactive");
|
|
#[cfg(debug_assertions)]
|
|
panic!("{}", msg);
|
|
return None;
|
|
}
|
|
};
|
|
|
|
let disabled = !router.can_go_back();
|
|
|
|
rsx! {
|
|
button { disabled: "{disabled}", prevent_default: "onclick", onclick: move |_| router.go_back(), {children} }
|
|
}
|
|
}
|
|
|
|
/// A button to go forward through the navigation history. Similar to a browsers forward button.
|
|
///
|
|
/// Only works as descendant of a [`Link`] component, otherwise it will be inactive.
|
|
///
|
|
/// The button will disable itself if it is known that no later history is available.
|
|
///
|
|
/// # Panic
|
|
/// - When the [`GoForwardButton`] is not nested within a [`Link`] component
|
|
/// hook, but only in debug builds.
|
|
///
|
|
/// # Example
|
|
/// ```rust
|
|
/// # use dioxus::prelude::*;
|
|
/// # use dioxus_router::prelude::*;
|
|
/// #[derive(Clone, Routable)]
|
|
/// enum Route {
|
|
/// #[route("/")]
|
|
/// Index {},
|
|
/// }
|
|
///
|
|
/// #[component]
|
|
/// fn App() -> Element {
|
|
/// rsx! {
|
|
/// Router::<Route> {}
|
|
/// }
|
|
/// }
|
|
///
|
|
/// #[component]
|
|
/// fn Index() -> Element {
|
|
/// rsx! {
|
|
/// GoForwardButton {
|
|
/// "go forward"
|
|
/// }
|
|
/// }
|
|
/// }
|
|
/// #
|
|
/// # let mut vdom = VirtualDom::new(App);
|
|
/// # let _ = vdom.rebuild();
|
|
/// # assert_eq!(
|
|
/// # dioxus_ssr::render(&vdom),
|
|
/// # r#"<button disabled="true" dioxus-prevent-default="onclick">go forward</button>"#
|
|
/// # );
|
|
/// ```
|
|
#[component]
|
|
pub fn GoForwardButton(
|
|
/// Props...
|
|
mut props: HistoryButtonProps,
|
|
) -> Element {
|
|
let HistoryButtonProps { children } = props;
|
|
|
|
// hook up to router
|
|
let router = match use_router_internal() {
|
|
Some(r) => r,
|
|
#[allow(unreachable_code)]
|
|
None => {
|
|
let msg = "`GoForwardButton` must have access to a parent router";
|
|
error!("{msg}, will be inactive");
|
|
#[cfg(debug_assertions)]
|
|
panic!("{}", msg);
|
|
return None;
|
|
}
|
|
};
|
|
|
|
let disabled = !router.can_go_forward();
|
|
|
|
rsx! {
|
|
button { disabled: "{disabled}", prevent_default: "onclick", onclick: move |_| router.go_forward(), {children} }
|
|
}
|
|
}
|