Walkthrough of the Hello World Example Internals
This walkthrough will take you through the internals of the Hello World example program. It will explain how major parts of Dioxus internals interact with each other to take the readme example from a source file to a running application. This guide should serve as a high-level overview of the internals of Dioxus. It is not meant to be a comprehensive guide.
The Source File
We start will a hello world program. This program renders a desktop app with the text "Hello World" in a webview.
//! Example: README.md showcase //! //! The example from the README.md. use dioxus::prelude::*; fn main() { dioxus_desktop::launch(app); } fn app(cx: Scope) -> Element { let mut count = use_state(cx, || 0); cx.render(rsx! { h1 { "High-Five counter: {count}" } button { onclick: move |_| count += 1, "Up high!" } button { onclick: move |_| count -= 1, "Down low!" } }) }
The rsx! Macro
Before the Rust compiler runs the program, it will expand all macros. Here is what the hello world example looks like expanded:
use dioxus::prelude::*; fn main() { dioxus_desktop::launch(app); } fn app(cx: Scope) -> Element { let mut count = use_state(cx, || 0); cx.render( // rsx expands to LazyNodes::new ::dioxus::core::LazyNodes::new( move |__cx: &::dioxus::core::ScopeState| -> ::dioxus::core::VNode { // The template is every static part of the rsx static TEMPLATE: ::dioxus::core::Template = ::dioxus::core::Template { // This is the source location of the rsx that generated this template. This is used to make hot rsx reloading work. Hot rsx reloading just replaces the template with a new one generated from the rsx by the CLI. name: "examples\\readme.rs:14:15:250", // The root nodes are the top level nodes of the rsx roots: &[ // The h1 node ::dioxus::core::TemplateNode::Element { // Find the built in h1 tag in the dioxus_elements crate exported by the dioxus html crate tag: dioxus_elements::h1::TAG_NAME, namespace: dioxus_elements::h1::NAME_SPACE, attrs: &[], // The children of the h1 node children: &[ // The dynamic count text node // Any nodes that are dynamic have a dynamic placeholder with a unique index ::dioxus::core::TemplateNode::DynamicText { // This index is used to find what element in `dynamic_nodes` to use instead of the placeholder id: 0usize, }, ], }, // The up high button node ::dioxus::core::TemplateNode::Element { tag: dioxus_elements::button::TAG_NAME, namespace: dioxus_elements::button::NAME_SPACE, attrs: &[ // The dynamic onclick listener attribute // Any attributes that are dynamic have a dynamic placeholder with a unique index. ::dioxus::core::TemplateAttribute::Dynamic { // Similar to dynamic nodes, dynamic attributes have a unique index used to find the attribute in `dynamic_attrs` to use instead of the placeholder id: 0usize, }, ], children: &[::dioxus::core::TemplateNode::Text { text: "Up high!" }], }, // The down low button node ::dioxus::core::TemplateNode::Element { tag: dioxus_elements::button::TAG_NAME, namespace: dioxus_elements::button::NAME_SPACE, attrs: &[ // The dynamic onclick listener attribute ::dioxus::core::TemplateAttribute::Dynamic { id: 1usize }, ], children: &[::dioxus::core::TemplateNode::Text { text: "Down low!" }], }, ], // Node paths is a list of paths to every dynamic node in the rsx node_paths: &[ // The first node path is the path to the dynamic node with an id of 0 (the count text node) &[ // Go to the index 0 root node 0u8, // // Go to the first child of the root node 0u8, ], ], // Attr paths is a list of paths to every dynamic attribute in the rsx attr_paths: &[ // The first attr path is the path to the dynamic attribute with an id of 0 (the up high button onclick listener) &[ // Go to the index 1 root node 1u8, ], // The second attr path is the path to the dynamic attribute with an id of 1 (the down low button onclick listener) &[ // Go to the index 2 root node 2u8, ], ], }; // The VNode is a reference to the template with the dynamic parts of the rsx ::dioxus::core::VNode { parent: None, key: None, // The static template this node will use. The template is stored in a Cell so it can be replaced with a new template when hot rsx reloading is enabled template: std::cell::Cell::new(TEMPLATE), root_ids: Default::default(), dynamic_nodes: __cx.bump().alloc([ // The dynamic count text node (dynamic node id 0) __cx.text_node(format_args!("High-Five counter: {0}", count)), ]), dynamic_attrs: __cx.bump().alloc([ // The dynamic up high button onclick listener (dynamic attribute id 0) dioxus_elements::events::onclick(__cx, move |_| count += 1), // The dynamic down low button onclick listener (dynamic attribute id 1) dioxus_elements::events::onclick(__cx, move |_| count -= 1), ]), } }, ), ) }
The rsx macro separates the static parts of the rsx (the template) and the dynamic parts (the dynamic_nodes and dynamic_attributes).
The static template only contains the parts of the rsx that cannot change at runtime with holes for the dynamic parts:
The dynamic_nodes and dynamic_attributes are the parts of the rsx that can change at runtime:
Launching the App
The app is launched by calling the launch function with the root component. Internally, this function will create a new web view using wry and create a virtual dom with the root component. This guide will not explain the renderer in-depth, but you can read more about it in the custom renderer section.
The Virtual DOM
Before we dive into the initial render in the virtual dom, we need to discuss what the virtual dom is. The virtual dom is a representation of the dom that is used to diff the current dom from the new dom. This diff is then used to create a list of mutations that need to be applied to the dom.
The Virtual Dom roughly looks like this:
#![allow(unused)] fn main() { pub struct VirtualDom { // All the templates that have been created or set durring hot reloading pub(crate) templates: FxHashMap<TemplateId, FxHashMap<usize, Template<'static>>>, // A slab of all the scopes that have been created pub(crate) scopes: ScopeSlab, // All scopes that have been marked as dirty pub(crate) dirty_scopes: BTreeSet<DirtyScope>, // Every element is actually a dual reference - one to the template and the other to the dynamic node in that template pub(crate) elements: Slab<ElementRef>, // This receiver is used to receive messages from hooks about what scopes need to be marked as dirty pub(crate) rx: futures_channel::mpsc::UnboundedReceiver<SchedulerMsg>, // The changes queued up to be sent to the renderer pub(crate) mutations: Mutations<'static>, } }
What is a slab? A slab acts like a hashmap with integer keys if you don't care about the value of the keys. It is internally backed by a dense vector which makes it more efficient than a hashmap. When you insert a value into a slab, it returns an integer key that you can use to retrieve the value later.
How does Dioxus use slabs? Dioxus uses "synchronized slabs" to communicate between the renderer and the VDOM. When an node is created in the Virtual Dom, a ElementId is passed along with the mutation to the renderer to identify the node. These ids are used by the Virtual Dom to reference that nodes in future mutations like setting an attribute on a node or removing a node. When the renderer sends an event to the Virtual Dom, it sends the ElementId of the node that the event was triggered on. The Virtual Dom uses this id to find the node in the slab and then run the necessary event handlers.
The virtual dom is a tree of scopes. A new scope is created for every component when it is first rendered and recycled when the component is unmounted.
Scopes serve three main purposes:
- They store the state of hooks used by the component
- They store the state for the context API
- They store the current and previous VNode that was rendered for diffing
The Initial Render
The root scope is created and rebuilt:
- The root component is run
- The root component returns a VNode
- Mutations for the VNode are created and added to the mutation list (this may involve creating new child components)
- The VNode is stored in the root scope
After the root scope is built, the mutations are sent to the renderer to be applied to the dom.
After the initial render, the root scope looks like this:
Waiting for Events
The Virtual Dom will only ever rerender a scope if it is marked as dirty. Each hook is responsible for marking the scope as dirty if the state has changed. Hooks can mark a scope as dirty by sending a message to the Virtual Dom's channel.
There are generally two ways a scope is marked as dirty:
- The renderer triggers an event: This causes an event listener to be called if needed which may mark a component as dirty
- The renderer calls wait for work: This polls futures which may mark a component as dirty
Once at least one scope is marked as dirty, the renderer can call render_with_deadline to diff the dirty scopes.
Diffing Scopes
If the user clicked the "up high" button, the root scope would be marked as dirty by the use_state hook. Once the desktop renderer calls render_with_deadline, the root scope would be diffed.
To start the diffing process, the component is run. After the root component is run it will look like this:
Next, the Virtual Dom will compare the new VNode with the previous VNode and only update the parts of the tree that have changed.
When a component is re-rendered, the Virtual Dom will compare the new VNode with the previous VNode and only update the parts of the tree that have changed.
The diffing algorithm goes through the list of dynamic attributes and nodes and compares them to the previous VNode. If the attribute or node has changed, a mutation that describes the change is added to the mutation list.
Here is what the diffing algorithm looks like for the root scope (red lines indicate that a mutation was generated, and green lines indicate that no mutation was generated)
Conclusion
This is only a brief overview of how the Virtual Dom works. There are several aspects not yet covered in this guide including how the Virtual Dom handles async-components, keyed diffing, and how it uses bump allocation to efficiently allocate VNodes. If need more information about the Virtual Dom, you can read the code of the core crate or reach out to us on Discord.