Struct Config 

pub struct Config { /* private fields */ }

Configuration for the WebSys renderer for the Dioxus VirtualDOM.

This struct helps configure the specifics of hydration and render destination for WebSys.

Example

dioxus_web::launch(App, Config::new().hydrate(true).root_name("myroot"))

Implementations

impl Config

pub fn new() -> Self

Create a new Default instance of the Config.

This is no different than calling Config::default()

pub fn rootname(self, name: impl Into<String>) -> Self

Set the name of the element that Dioxus will use as the root.

This is akin to calling React.render() on the element with the specified name. Note that this only works on the current document, i.e. window.document. To use a different document (popup, iframe, …) use Self::rootelement instead.

pub fn rootelement(self, elem: Element) -> Self

Set the element that Dioxus will use as root.

This is akin to calling React.render() on the given element.

pub fn rootnode(self, node: Node) -> Self

Set the node that Dioxus will use as root.

This is akin to calling React.render() on the given element.

pub fn history(self, history: Rc<dyn History>) -> Self

Set the history provider for the application.

dioxus-web provides two history providers:

• dioxus_history::WebHistory: A history provider that uses the browser history API.
• dioxus_history::HashHistory: A history provider that uses the # url fragment.

By default, dioxus-web uses the WebHistory provider, but this method can be used to configure a different history provider.

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl LaunchConfig for Config