dioxus-web 0.7.6

Web-sys renderer for Dioxus: Build fullstack web, desktop, and mobile apps with a single codebase.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use std::rc::Rc;

use dioxus_core::LaunchConfig;
use wasm_bindgen::JsCast as _;

///  Configuration for the WebSys renderer for the Dioxus VirtualDOM.
///
/// This struct helps configure the specifics of hydration and render destination for WebSys.
///
/// # Example
///
/// ```rust, ignore
/// dioxus_web::launch(App, Config::new().hydrate(true).root_name("myroot"))
/// ```
pub struct Config {
    pub(crate) hydrate: bool,
    #[allow(dead_code)]
    pub(crate) panic_hook: bool,
    pub(crate) root: ConfigRoot,
    #[cfg(feature = "document")]
    pub(crate) history: Option<Rc<dyn dioxus_history::History>>,
}

impl LaunchConfig for Config {}

pub(crate) enum ConfigRoot {
    RootName(String),
    RootNode(web_sys::Node),
}

impl Config {
    /// Create a new Default instance of the Config.
    ///
    /// This is no different than calling `Config::default()`
    pub fn new() -> Self {
        Self::default()
    }

    #[cfg(feature = "hydrate")]
    /// Enable SSR hydration
    ///
    /// This enables Dioxus to pick up work from a pre-rendered 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 hydrate(mut self, f: bool) -> Self {
        self.hydrate = f;
        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 rootname(mut self, name: impl Into<String>) -> Self {
        self.root = ConfigRoot::RootName(name.into());
        self
    }

    /// Set the element that Dioxus will use as root.
    ///
    /// This is akin to calling React.render() on the given element.
    pub fn rootelement(mut self, elem: web_sys::Element) -> Self {
        self.root = ConfigRoot::RootNode(elem.unchecked_into());
        self
    }

    /// Set the node that Dioxus will use as root.
    ///
    /// This is akin to calling React.render() on the given element.
    pub fn rootnode(mut self, node: web_sys::Node) -> Self {
        self.root = ConfigRoot::RootNode(node);
        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.
    pub fn history(mut self, history: Rc<dyn dioxus_history::History>) -> Self {
        #[cfg(feature = "document")]
        {
            self.history = Some(history);
        }
        self
    }
}

impl Default for Config {
    fn default() -> Self {
        Self {
            hydrate: false,
            root: ConfigRoot::RootName("main".to_string()),
            #[cfg(feature = "document")]
            history: None,
            panic_hook: true,
        }
    }
}