Struct WebHistory 

pub struct WebHistory { /* private fields */ }

A dioxus_history::History provider that integrates with a browser via the History API.

Prefix

This dioxus_history::History 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 dioxus_history::History 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 WebHistory

pub fn new(prefix: Option<String>, do_scroll_restoration: bool) -> Self

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 Default for WebHistory

fn default() -> Self

Returns the “default value” for a type.

impl History for WebHistory

fn current_route(&self) -> String

Get the path of the current URL.

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

Get the current path prefix of the URL.

fn go_back(&self)

Go back to a previous page.

fn go_forward(&self)

Go forward to a future page.

fn push(&self, state: String)

Go to another page.

fn replace(&self, state: String)

Replace the current page with another one.

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

Navigate to an external URL.

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

Provide the History 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.

fn include_prevent_default(&self) -> bool

Whether the router should include the legacy prevent default attribute instead of the new prevent default method. This should only be used by liveview.