Struct dioxus_web::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 hydrate(self, f: bool) -> Self

Enable SSR hydration

This enables Dioxus to pick up work from a pre-renderd HTML file. Hydration will completely skip over any async work and suspended nodes.

Dioxus will load up all the elements with the dio_el data attribute into memory when the page is loaded.

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

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

This is akint to calling React.render() on the element with the specified name.

pub fn with_string_cache(self, cache: Vec<String>) -> Self

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

This is akint to calling React.render() on the element with the specified name.

pub fn with_default_panic_hook(self, f: bool) -> Self

Set whether or not Dioxus should use the built-in panic hook or defer to your own.

The panic hook is set to true normally so even the simplest apps have helpful error messages.

Trait Implementations

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.