Struct dioxus_router::prelude::WebHistory

pub struct WebHistory<R: Routable> { /* private fields */ }

A HistoryProvider that integrates with a browser via the History API.

Prefix

This HistoryProvider supports a prefix, which can be used for web apps that aren’t located at the root of their domain.

Application developers are responsible for ensuring that right after the prefix comes a /. If that is not the case, this HistoryProvider will replace the first character after the prefix with one.

Application developers are responsible for not rendering the router if the prefix is not present in the URL. Otherwise, if a router navigation is triggered, the prefix will be added.

Implementations

impl<R: Routable> WebHistory<R>

pub fn new(prefix: Option<String>, do_scroll_restoration: bool) -> Selfwhere <R as FromStr>::Err: Display,

Create a new WebHistory.

If do_scroll_restoration is true, WebHistory will take control of the history state. It’ll also set the browsers scroll restoration to manual.

Trait Implementations

impl<R: Routable> Default for WebHistory<R>where <R as FromStr>::Err: Display,

fn default() -> Self

Returns the “default value” for a type.

impl<R: Routable> HistoryProvider<R> for WebHistory<R>where <R as FromStr>::Err: Display,

fn current_route(&self) -> R

Get the path of the current URL.

fn current_prefix(&self) -> Option<String>

Get the current path prefix of the URL.

fn go_back(&mut self)

Go back to a previous page.

fn go_forward(&mut self)

Go forward to a future page.

fn push(&mut self, state: R)

Go to another page.

fn replace(&mut self, state: R)

Replace the current page with another one.

fn external(&mut self, url: String) -> bool

Navigate to an external URL.

fn updater(&mut self, callback: Arc<dyn Fn() + Send + Sync>)

Provide the HistoryProvider with an update callback.

fn can_go_back(&self) -> bool

Check whether there is a previous page to navigate back to.

fn can_go_forward(&self) -> bool

Check whether there is a future page to navigate forward to.