|
@@ -2,7 +2,7 @@
|
|
|
|
|
|
Dioxus is an incredibly portable framework for UI development. The lessons, knowledge, hooks, and components you acquire over time can always be used for future projects. However, sometimes those projects cannot leverage a supported renderer or you need to implement your own better renderer.
|
|
|
|
|
|
-Great news: the design of the renderer is entirely up to you! We provide suggestions and inspiration with the 1st party renderers, but only really require processing `DomEdits` and sending `UserEvents`.
|
|
|
+Great news: the design of the renderer is entirely up to you! We provide suggestions and inspiration with the 1st party renderers, but only really require processing `Mutations` and sending `UserEvents`.
|
|
|
|
|
|
## The specifics:
|
|
|
|
|
@@ -11,153 +11,225 @@ Implementing the renderer is fairly straightforward. The renderer needs to:
|
|
|
1. Handle the stream of edits generated by updates to the virtual DOM
|
|
|
2. Register listeners and pass events into the virtual DOM's event system
|
|
|
|
|
|
-Essentially, your renderer needs to implement the `RealDom` trait and generate `EventTrigger` objects to update the VirtualDOM. From there, you'll have everything needed to render the VirtualDOM to the screen.
|
|
|
+Essentially, your renderer needs to process edits and generate events to update the VirtualDOM. From there, you'll have everything needed to render the VirtualDOM to the screen.
|
|
|
|
|
|
Internally, Dioxus handles the tree relationship, diffing, memory management, and the event system, leaving as little as possible required for renderers to implement themselves.
|
|
|
|
|
|
-For reference, check out the javascript interperter or tui renderer as a starting point for your custom renderer.
|
|
|
+For reference, check out the [javascript interpreter](https://github.com/DioxusLabs/dioxus/tree/master/packages/interpreter) or [tui renderer](https://github.com/DioxusLabs/dioxus/tree/master/packages/tui) as a starting point for your custom renderer.
|
|
|
|
|
|
-## DomEdits
|
|
|
+## Templates
|
|
|
|
|
|
-The "DomEdit" type is a serialized enum that represents an atomic operation occurring on the RealDom. The variants roughly follow this set:
|
|
|
+Dioxus is built around the concept of [Templates](https://docs.rs/dioxus-core/latest/dioxus_core/prelude/struct.Template.html). Templates describe a UI tree known at compile time with dynamic parts filled at runtime. This is useful internally to make skip diffing static nodes, but it is also useful for the renderer to reuse parts of the UI tree. This can be useful for things like a list of items. Each item could contain some static parts and some dynamic parts. The renderer can use the template to create a static part of the UI once, clone it for each element in the list, and then fill in the dynamic parts.
|
|
|
+
|
|
|
+## Mutations
|
|
|
+
|
|
|
+The `Mutation` type is a serialized enum that represents an operation that should be applied to update the UI. The variants roughly follow this set:
|
|
|
|
|
|
```rust
|
|
|
-enum DomEdit {
|
|
|
- PushRoot,
|
|
|
+enum Mutation {
|
|
|
AppendChildren,
|
|
|
+ AssignId,
|
|
|
+ CreatePlaceholder,
|
|
|
+ CreateTextNode,
|
|
|
+ HydrateText,
|
|
|
+ LoadTemplate,
|
|
|
ReplaceWith,
|
|
|
+ ReplacePlaceholder,
|
|
|
InsertAfter,
|
|
|
InsertBefore,
|
|
|
- Remove,
|
|
|
- CreateTextNode,
|
|
|
- CreateElement,
|
|
|
- CreateElementNs,
|
|
|
- CreatePlaceholder,
|
|
|
+ SetAttribute,
|
|
|
+ SetText,
|
|
|
NewEventListener,
|
|
|
RemoveEventListener,
|
|
|
- SetText,
|
|
|
- SetAttribute,
|
|
|
- RemoveAttribute,
|
|
|
- PopRoot,
|
|
|
+ Remove,
|
|
|
+ PushRoot,
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-The Dioxus diffing mechanism operates as a [stack machine](https://en.wikipedia.org/wiki/Stack_machine) where the "push_root" method pushes a new "real" DOM node onto the stack and "append_child" and "replace_with" both remove nodes from the stack.
|
|
|
+The Dioxus diffing mechanism operates as a [stack machine](https://en.wikipedia.org/wiki/Stack_machine) where the [LoadTemplate](https://docs.rs/dioxus-core/latest/dioxus_core/enum.Mutation.html#variant.LoadTemplate), [CreatePlaceholder](https://docs.rs/dioxus-core/latest/dioxus_core/enum.Mutation.html#variant.CreatePlaceholder), and [CreateTextNode](https://docs.rs/dioxus-core/latest/dioxus_core/enum.Mutation.html#variant.CreateTextNode) mutations pushes a new "real" DOM node onto the stack and [AppendChildren](https://docs.rs/dioxus-core/latest/dioxus_core/enum.Mutation.html#variant.AppendChildren), [InsertAfter](https://docs.rs/dioxus-core/latest/dioxus_core/enum.Mutation.html#variant.InsertAfter), [InsertBefore](https://docs.rs/dioxus-core/latest/dioxus_core/enum.Mutation.html#variant.InsertBefore), [ReplacePlaceholder](https://docs.rs/dioxus-core/latest/dioxus_core/enum.Mutation.html#variant.ReplacePlaceholder), and [ReplaceWith](https://docs.rs/dioxus-core/latest/dioxus_core/enum.Mutation.html#variant.ReplaceWith) all remove nodes from the stack.
|
|
|
|
|
|
+## Node storage
|
|
|
|
|
|
-### An example
|
|
|
+Dioxus saves and loads elements with IDs. Inside the VirtualDOM, this is just tracked as as a u64.
|
|
|
|
|
|
-For the sake of understanding, lets consider this example – a very simple UI declaration:
|
|
|
+Whenever a `CreateElement` edit is generated during diffing, Dioxus increments its node counter and assigns that new element its current NodeCount. The RealDom is responsible for remembering this ID and pushing the correct node when id is used in a mutation. Dioxus reclaims the IDs of elements when removed. To stay in sync with Dioxus you can use a sparse Vec (Vec<Option<T>>) with possibly unoccupied items. You can use the ids as indexes into the Vec for elements, and grow the Vec when an id does not exist.
|
|
|
+
|
|
|
+### An Example
|
|
|
+
|
|
|
+For the sake of understanding, let's consider this example – a very simple UI declaration:
|
|
|
|
|
|
```rust
|
|
|
-rsx!( h1 {"hello world"} )
|
|
|
+rsx!( h1 {"count: {x}"} )
|
|
|
```
|
|
|
|
|
|
-To get things started, Dioxus must first navigate to the container of this h1 tag. To "navigate" here, the internal diffing algorithm generates the DomEdit `PushRoot` where the ID of the root is the container.
|
|
|
+#### Building Templates
|
|
|
+
|
|
|
+The above rsx will create a template that contains one static h1 tag and a placeholder for a dynamic text node. The template contains the static parts of the UI, and ids for the dynamic parts along with the paths to access them.
|
|
|
|
|
|
-When the renderer receives this instruction, it pushes the actual Node onto its own stack. The real renderer's stack will look like this:
|
|
|
+The template will look something like this:
|
|
|
|
|
|
```rust
|
|
|
-instructions: [
|
|
|
- PushRoot(Container)
|
|
|
-]
|
|
|
-stack: [
|
|
|
- ContainerNode,
|
|
|
-]
|
|
|
+Template {
|
|
|
+ // Some id that is unique for the entire project
|
|
|
+ name: "main.rs:1:1:0",
|
|
|
+ // The root nodes of the template
|
|
|
+ roots: &[
|
|
|
+ TemplateNode::Element {
|
|
|
+ tag: "h1",
|
|
|
+ namespace: None,
|
|
|
+ attrs: &[],
|
|
|
+ children: &[
|
|
|
+ TemplateNode::DynamicText {
|
|
|
+ id: 0
|
|
|
+ },
|
|
|
+ ],
|
|
|
+ }
|
|
|
+ ],
|
|
|
+ // the path to each of the dynamic nodes
|
|
|
+ node_paths: &[
|
|
|
+ // the path to dynamic node with a id of 0
|
|
|
+ &[
|
|
|
+ // on the first root node
|
|
|
+ 0,
|
|
|
+ // the first child of the root node
|
|
|
+ 0,
|
|
|
+ ]
|
|
|
+ ],
|
|
|
+ // the path to each of the dynamic attributes
|
|
|
+ attr_paths: &'a [&'a [u8]],
|
|
|
+}
|
|
|
```
|
|
|
|
|
|
-Next, Dioxus will encounter the h1 node. The diff algorithm decides that this node needs to be created, so Dioxus will generate the DomEdit `CreateElement`. When the renderer receives this instruction, it will create an unmounted node and push into its own stack:
|
|
|
+> For more detailed docs about the struture of templates see the [Template api docs](https://docs.rs/dioxus-core/latest/dioxus_core/prelude/struct.Template.html)
|
|
|
+
|
|
|
+This template will be sent to the renderer in the [list of templates](https://docs.rs/dioxus-core/latest/dioxus_core/struct.Mutations.html#structfield.templates) supplied with the mutations the first time it is used. Any time the renderer encounters a [LoadTemplate](https://docs.rs/dioxus-core/latest/dioxus_core/enum.Mutation.html#variant.LoadTemplate) mutation after this, it should clone the template and store it in the given id.
|
|
|
+
|
|
|
+For dynamic nodes and dynamic text nodes, a placeholder node should be created and inserted into the UI so that the node can be modified later.
|
|
|
+
|
|
|
+In HTML renderers, this template could look like this:
|
|
|
+
|
|
|
+```html
|
|
|
+<h1>""</h1>
|
|
|
+```
|
|
|
+
|
|
|
+#### Applying Mutations
|
|
|
+
|
|
|
+After the renderer has created all of the new templates, it can begin to process the mutations.
|
|
|
+
|
|
|
+When the renderer starts, it should contain the Root node on the stack and store the Root node with an id of 0. The Root node is the top-level node of the UI. In HTML, this is the `<div id="main">` element.
|
|
|
|
|
|
```rust
|
|
|
-instructions: [
|
|
|
- PushRoot(Container),
|
|
|
- CreateElement(h1),
|
|
|
-]
|
|
|
+instructions: []
|
|
|
stack: [
|
|
|
- ContainerNode,
|
|
|
- h1,
|
|
|
+ RootNode,
|
|
|
+]
|
|
|
+nodes: [
|
|
|
+ RootNode,
|
|
|
]
|
|
|
```
|
|
|
-Next, Dioxus sees the text node, and generates the `CreateTextNode` DomEdit:
|
|
|
+
|
|
|
+The first mutation is a `LoadTemplate` mutation. This tells the renderer to load a root from the template with the given id. The renderer will then push the root node of the template onto the stack and store it with an id for later. In this case, the root node is an h1 element.
|
|
|
+
|
|
|
```rust
|
|
|
instructions: [
|
|
|
- PushRoot(Container),
|
|
|
- CreateElement(h1),
|
|
|
- CreateTextNode("hello world")
|
|
|
+ LoadTemplate {
|
|
|
+ // the id of the template
|
|
|
+ name: "main.rs:1:1:0",
|
|
|
+ // the index of the root node in the template
|
|
|
+ index: 0,
|
|
|
+ // the id to store
|
|
|
+ id: ElementId(1),
|
|
|
+ }
|
|
|
]
|
|
|
stack: [
|
|
|
- ContainerNode,
|
|
|
- h1,
|
|
|
- "hello world"
|
|
|
+ RootNode,
|
|
|
+ <h1>""</h1>,
|
|
|
+]
|
|
|
+nodes: [
|
|
|
+ RootNode,
|
|
|
+ <h1>""</h1>,
|
|
|
]
|
|
|
```
|
|
|
-Remember, the text node is not attached to anything (it is unmounted) so Dioxus needs to generate an Edit that connects the text node to the h1 element. It depends on the situation, but in this case we use `AppendChildren`. This pops the text node off the stack, leaving the h1 element as the next element in line.
|
|
|
+
|
|
|
+Next, Dioxus will create the dynamic text node. The diff algorithm decides that this node needs to be created, so Dioxus will generate the Mutation `HydrateText`. When the renderer receives this instruction, it will navigate to the placeholder text node in the template and replace it with the new text.
|
|
|
|
|
|
```rust
|
|
|
instructions: [
|
|
|
- PushRoot(Container),
|
|
|
- CreateElement(h1),
|
|
|
- CreateTextNode("hello world"),
|
|
|
- AppendChildren(1)
|
|
|
+ LoadTemplate {
|
|
|
+ name: "main.rs:1:1:0",
|
|
|
+ index: 0,
|
|
|
+ id: ElementId(1),
|
|
|
+ },
|
|
|
+ HydrateText {
|
|
|
+ // the id to store the text node
|
|
|
+ id: ElementId(2),
|
|
|
+ // the text to set
|
|
|
+ text: "count: 0",
|
|
|
+ }
|
|
|
]
|
|
|
stack: [
|
|
|
- ContainerNode,
|
|
|
- h1
|
|
|
+ RootNode,
|
|
|
+ <h1>"count: 0"</h1>,
|
|
|
+]
|
|
|
+nodes: [
|
|
|
+ RootNode,
|
|
|
+ <h1>"count: 0"</h1>,
|
|
|
+ "count: 0",
|
|
|
]
|
|
|
```
|
|
|
-We call `AppendChildren` again, popping off the h1 node and attaching it to the parent:
|
|
|
+
|
|
|
+Remember, the h1 node is not attached to anything (it is unmounted) so Dioxus needs to generate an Edit that connects the h1 node to the Root. It depends on the situation, but in this case, we use `AppendChildren`. This pops the text node off the stack, leaving the Root element as the next element on the stack.
|
|
|
+
|
|
|
```rust
|
|
|
instructions: [
|
|
|
- PushRoot(Container),
|
|
|
- CreateElement(h1),
|
|
|
- CreateTextNode("hello world"),
|
|
|
- AppendChildren(1),
|
|
|
- AppendChildren(1)
|
|
|
+ LoadTemplate {
|
|
|
+ name: "main.rs:1:1:0",
|
|
|
+ index: 0,
|
|
|
+ id: ElementId(1),
|
|
|
+ },
|
|
|
+ HydrateText {
|
|
|
+ id: ElementId(2),
|
|
|
+ text: "count: 0",
|
|
|
+ },
|
|
|
+ AppendChildren {
|
|
|
+ // the id of the parent node
|
|
|
+ id: ElementId(0),
|
|
|
+ // the number of nodes to pop off the stack and append
|
|
|
+ m: 1
|
|
|
+ }
|
|
|
]
|
|
|
stack: [
|
|
|
- ContainerNode,
|
|
|
+ RootNode,
|
|
|
]
|
|
|
-```
|
|
|
-Finally, the container is popped since we don't need it anymore.
|
|
|
-```rust
|
|
|
-instructions: [
|
|
|
- PushRoot(Container),
|
|
|
- CreateElement(h1),
|
|
|
- CreateTextNode("hello world"),
|
|
|
- AppendChildren(1),
|
|
|
- AppendChildren(1),
|
|
|
- PopRoot
|
|
|
+nodes: [
|
|
|
+ RootNode,
|
|
|
+ <h1>"count: 0"</h1>,
|
|
|
+ "count: 0",
|
|
|
]
|
|
|
-stack: []
|
|
|
```
|
|
|
+
|
|
|
Over time, our stack looked like this:
|
|
|
+
|
|
|
```rust
|
|
|
-[]
|
|
|
-[Container]
|
|
|
-[Container, h1]
|
|
|
-[Container, h1, "hello world"]
|
|
|
-[Container, h1]
|
|
|
-[Container]
|
|
|
-[]
|
|
|
+[Root]
|
|
|
+[Root, <h1>""</h1>]
|
|
|
+[Root, <h1>"count: 0"</h1>]
|
|
|
+[Root]
|
|
|
```
|
|
|
|
|
|
-Notice how our stack is empty once UI has been mounted. Conveniently, this approach completely separates the VirtualDOM and the Real DOM. Additionally, these edits are serializable, meaning we can even manage UIs across a network connection. This little stack machine and serialized edits makes Dioxus independent of platform specifics.
|
|
|
+Conveniently, this approach completely separates the Virtual DOM and the Real DOM. Additionally, these edits are serializable, meaning we can even manage UIs across a network connection. This little stack machine and serialized edits make Dioxus independent of platform specifics.
|
|
|
|
|
|
Dioxus is also really fast. Because Dioxus splits the diff and patch phase, it's able to make all the edits to the RealDOM in a very short amount of time (less than a single frame) making rendering very snappy. It also allows Dioxus to cancel large diffing operations if higher priority work comes in while it's diffing.
|
|
|
|
|
|
-It's important to note that there _is_ one layer of connectedness between Dioxus and the renderer. Dioxus saves and loads elements (the PushRoot edit) with an ID. Inside the VirtualDOM, this is just tracked as a u64.
|
|
|
-
|
|
|
-Whenever a `CreateElement` edit is generated during diffing, Dioxus increments its node counter and assigns that new element its current NodeCount. The RealDom is responsible for remembering this ID and pushing the correct node when PushRoot(ID) is generated. Dioxus reclaims IDs of elements when removed. To stay in sync with Dioxus you can use a sparce Vec (Vec<Option<T>>) with possibly unoccupied items. You can use the ids as indexes into the Vec for elements, and grow the Vec when a id does not exist.
|
|
|
-
|
|
|
-This little demo serves to show exactly how a Renderer would need to process an edit stream to build UIs. A set of serialized DomEditss for various demos is available for you to test your custom renderer against.
|
|
|
+This little demo serves to show exactly how a Renderer would need to process a mutation stream to build UIs.
|
|
|
|
|
|
## Event loop
|
|
|
|
|
|
-Like most GUIs, Dioxus relies on an event loop to progress the VirtualDOM. The VirtualDOM itself can produce events as well, so it's important that your custom renderer can handle those too.
|
|
|
+Like most GUIs, Dioxus relies on an event loop to progress the VirtualDOM. The VirtualDOM itself can produce events as well, so it's important for your custom renderer can handle those too.
|
|
|
|
|
|
The code for the WebSys implementation is straightforward, so we'll add it here to demonstrate how simple an event loop is:
|
|
|
|
|
|
-```rust
|
|
|
+```rust, ignore
|
|
|
pub async fn run(&mut self) -> dioxus_core::error::Result<()> {
|
|
|
// Push the body element onto the WebsysDom's stack machine
|
|
|
let mut websys_dom = crate::new::WebsysDom::new(prepare_websys_dom());
|
|
@@ -185,9 +257,9 @@ pub async fn run(&mut self) -> dioxus_core::error::Result<()> {
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-It's important that you decode the real events from your event system into Dioxus' synthetic event system (synthetic meaning abstracted). This simply means matching your event type and creating a Dioxus `UserEvent` type. Right now, the VirtualEvent system is modeled almost entirely around the HTML spec, but we are interested in slimming it down.
|
|
|
+It's important to decode what the real events are for your event system into Dioxus' synthetic event system (synthetic meaning abstracted). This simply means matching your event type and creating a Dioxus `UserEvent` type. Right now, the virtual event system is modeled almost entirely around the HTML spec, but we are interested in slimming it down.
|
|
|
|
|
|
-```rust
|
|
|
+```rust, ignore
|
|
|
fn virtual_event_from_websys_event(event: &web_sys::Event) -> VirtualEvent {
|
|
|
match event.type_().as_str() {
|
|
|
"keydown" => {
|
|
@@ -219,40 +291,23 @@ fn virtual_event_from_websys_event(event: &web_sys::Event) -> VirtualEvent {
|
|
|
|
|
|
## Custom raw elements
|
|
|
|
|
|
-If you need to go as far as relying on custom elements for your renderer – you totally can. This still enables you to use Dioxus' reactive nature, component system, shared state, and other features, but will ultimately generate different nodes. All attributes and listeners for the HTML and SVG namespace are shuttled through helper structs that essentially compile away (pose no runtime overhead). You can drop in your own elements any time you want, with little hassle. However, you must be absolutely sure your renderer can handle the new type, or it will crash and burn.
|
|
|
-
|
|
|
-These custom elements are defined as unit structs with trait implementations.
|
|
|
+If you need to go as far as relying on custom elements/attributes for your renderer – you totally can. This still enables you to use Dioxus' reactive nature, component system, shared state, and other features, but will ultimately generate different nodes. All attributes and listeners for the HTML and SVG namespace are shuttled through helper structs that essentially compile away. You can drop in your elements any time you want, with little hassle. However, you must be sure your renderer can handle the new namespace.
|
|
|
|
|
|
-For example, the `div` element is (approximately!) defined as such:
|
|
|
-
|
|
|
-```rust
|
|
|
-struct div;
|
|
|
-impl div {
|
|
|
- /// Some glorious documentation about the class property.
|
|
|
- const TAG_NAME: &'static str = "div";
|
|
|
- const NAME_SPACE: Option<&'static str> = None;
|
|
|
- // define the class attribute
|
|
|
- pub fn class<'a>(&self, cx: NodeFactory<'a>, val: Arguments) -> Attribute<'a> {
|
|
|
- cx.attr("class", val, None, false)
|
|
|
- }
|
|
|
- // more attributes
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-You've probably noticed that many elements in the `rsx!` macros support on-hover documentation. The approach we take to custom elements means that the unit struct is created immediately where the element is used in the macro. When the macro is expanded, the doc comments still apply to the unit struct, giving tons of in-editor feedback, even inside a proc macro.
|
|
|
+For more examples and information on how to create custom namespaces, see the [`dioxus_html` crate](https://github.com/DioxusLabs/dioxus/blob/master/packages/html/README.md#how-to-extend-it).
|
|
|
|
|
|
# Native Core
|
|
|
|
|
|
-If you are creating a renderer in rust, native core provides some utilites to implement a renderer. It provides an abstraction over DomEdits and handles layout for you.
|
|
|
+If you are creating a renderer in rust, the [native-core](https://github.com/DioxusLabs/dioxus/tree/master/packages/native-core) crate provides some utilities to implement a renderer. It provides an abstraction over Mutations and Templates and contains helpers that can handle the layout and text editing for you.
|
|
|
|
|
|
-## RealDom
|
|
|
+## The RealDom
|
|
|
|
|
|
-The `RealDom` is a higher level abstraction over updating the Dom. It updates with `DomEdits` and provides a way to incrementally update the state of nodes based on what attributes change.
|
|
|
+The `RealDom` is a higher-level abstraction over updating the Dom. It uses an entity component system to manage the state of nodes. This system allows you to modify insert and modify arbitrary components on nodes. On top of this, the RealDom provides a way to manage a tree of nodes, and the State trait provides a way to automatically add and update these components when the tree is modified. It also provides a way to apply `Mutations` to the RealDom.
|
|
|
|
|
|
### Example
|
|
|
|
|
|
Let's build a toy renderer with borders, size, and text color.
|
|
|
-Before we start lets take a look at an example element we can render:
|
|
|
+Before we start let's take a look at an example element we can render:
|
|
|
+
|
|
|
```rust
|
|
|
cx.render(rsx!{
|
|
|
div{
|
|
@@ -265,11 +320,11 @@ cx.render(rsx!{
|
|
|
})
|
|
|
```
|
|
|
|
|
|
-In this tree the color depends on the parent's color. The size depends on the childrens size, the current text, and a text size. The border depends on only the current node.
|
|
|
+In this tree, the color depends on the parent's color. The layout depends on the children's layout, the current text, and the text size. The border depends on only the current node.
|
|
|
|
|
|
In the following diagram arrows represent dataflow:
|
|
|
|
|
|
-[](https://mermaid-js.github.io/mermaid-live-editor/edit#pako:eNqdVNFqgzAU_RXJXizUUZPJmIM-jO0LukdhpCbO0JhIGteW0n9fNK1Oa0brfUnu9VxyzzkXjyCVhIIYZFzu0hwr7X2-JcIzsa3W3wqXuZdKoele22oddfa1Y0Tnfn31muvMfqeCDNq3GmvaNROmaKqZFO1DPTRhP8MOd1fTWYNDvzlmQbBMJZcq9JtjNgY1mLVUhBqQPQeojl3wGCw5PsjqnIe-zXqEL8GZ2Kz0gVMPmoeU3ND4IcuiaLGY2zRouuKncv_qGKv3VodpJe0JVU6QCQ5kgqMyWQVr8hbk4hm1PBcmsuwmnrCVH94rP7xN_ucp8sOB_EPSfz9drYVrkpc_AmH8_yTjJueUc-ntpOJkgt2os9tKjcYlt-DLUiD3UsB2KZCLcwjv3Aq33-g2v0M0xXA0MBy5DUdXi-gcJZriuLmAOSioKjAj5ld8rMsJ0DktaAJicyVYbRKQiJPBVSUx438QpqUCcYb5ls4BrrRcHUTaFizqnWGzR8W5evoFI-bJdw)
|
|
|
+[](https://mermaid.live/edit#pako:eNqllV1vgjAUhv8K6W4wkQVa2QdLdrHsdlfukmSptEhjoaSWqTH-9xVwONAKst70g5739JzzlO5BJAgFAYi52EQJlsr6fAszS7d1sVhKnCdWJDJFt6peLVs5-9owohK7HFrVcFJ_pxnpmK8VVvRkTJikkWIiaxy1dhP23bUwW1WW5WbPrrqJ4ziR4EJ6dtVN2ls5y1ZztePUcrWZFCvqVEcPPDffvlyS1XoLIQnVgnVvVPR6FU9Zc-6dV453ojjOPbuetRJ57gIeXQR3cez7rjtteZyZQ2j5MqmjqwE0ZW0VKx9RKtgpFewp1aw3sXXFy6TWgiYlv8mfq1scD8ofbBCAfQg8_AMBOAyBxzEIwA4CxgQ99QbQkjnD2KT7_CfxGF8_9WXQEsq5sDZCcjICOXRCri4h6r3NA38Q6Jdi1EOx5w3DGDYYI6MUvJFjM3VoGHUeGoMd6mBnDmh2E3fo7O4Yhf0x4OkBmIKUyhQzol_GfbkcApXQlIYg0EOC5SoEYXbQ-3ChxHyXRSBQsqBTUOREx_7OsAY3BUGM-VqvUsKUkB_1U6vf05gtweEHTk4_HQ)
|
|
|
|
|
|
[//]: # "%% mermaid flow chart"
|
|
|
[//]: # "flowchart TB"
|
|
@@ -280,217 +335,79 @@ In the following diagram arrows represent dataflow:
|
|
|
[//]: # " direction TB"
|
|
|
[//]: # " subgraph div state"
|
|
|
[//]: # " direction TB"
|
|
|
-[//]: # " state1(state)-->color1(color)"
|
|
|
-[//]: # " state1-->border1(border)"
|
|
|
+[//]: # " state1(state)---color1(color)"
|
|
|
+[//]: # " linkStyle 0 stroke-width:10px;"
|
|
|
+[//]: # " state1---border1(border)"
|
|
|
+[//]: # " linkStyle 1 stroke-width:10px;"
|
|
|
[//]: # " text_width-.->layout_width1(layout width)"
|
|
|
[//]: # " linkStyle 2 stroke:#ff5500,stroke-width:4px;"
|
|
|
-[//]: # " state1-->layout_width1"
|
|
|
+[//]: # " state1---layout_width1"
|
|
|
+[//]: # " linkStyle 3 stroke-width:10px;"
|
|
|
[//]: # " end"
|
|
|
[//]: # " subgraph p state"
|
|
|
[//]: # " direction TB"
|
|
|
-[//]: # " state2(state)-->color2(color)"
|
|
|
+[//]: # " state2(state)---color2(color)"
|
|
|
+[//]: # " linkStyle 4 stroke-width:10px;"
|
|
|
[//]: # " color1-.->color2"
|
|
|
[//]: # " linkStyle 5 stroke:#0000ff,stroke-width:4px;"
|
|
|
-[//]: # " state2-->border2(border)"
|
|
|
+[//]: # " state2---border2(border)"
|
|
|
+[//]: # " linkStyle 6 stroke-width:10px;"
|
|
|
[//]: # " text_width-.->layout_width2(layout width)"
|
|
|
[//]: # " linkStyle 7 stroke:#ff5500,stroke-width:4px;"
|
|
|
-[//]: # " state2-->layout_width2"
|
|
|
+[//]: # " state2---layout_width2"
|
|
|
+[//]: # " linkStyle 8 stroke-width:10px;"
|
|
|
[//]: # " layout_width2-.->layout_width1"
|
|
|
[//]: # " linkStyle 9 stroke:#00aa00,stroke-width:4px;"
|
|
|
[//]: # " end"
|
|
|
[//]: # " subgraph hello world state"
|
|
|
[//]: # " direction TB"
|
|
|
-[//]: # " state3(state)-->border3(border)"
|
|
|
-[//]: # " state3-->color3(color)"
|
|
|
+[//]: # " state3(state)---border3(border)"
|
|
|
+[//]: # " linkStyle 10 stroke-width:10px;"
|
|
|
+[//]: # " state3---color3(color)"
|
|
|
+[//]: # " linkStyle 11 stroke-width:10px;"
|
|
|
[//]: # " color2-.->color3"
|
|
|
[//]: # " linkStyle 12 stroke:#0000ff,stroke-width:4px;"
|
|
|
[//]: # " text_width-.->layout_width3(layout width)"
|
|
|
[//]: # " linkStyle 13 stroke:#ff5500,stroke-width:4px;"
|
|
|
-[//]: # " state3-->layout_width3"
|
|
|
+[//]: # " state3---layout_width3"
|
|
|
+[//]: # " linkStyle 14 stroke-width:10px;"
|
|
|
[//]: # " layout_width3-.->layout_width2"
|
|
|
[//]: # " linkStyle 15 stroke:#00aa00,stroke-width:4px;"
|
|
|
[//]: # " end"
|
|
|
[//]: # " end"
|
|
|
|
|
|
-To help in building a Dom, native core provides four traits: State, ChildDepState, ParentDepState, and NodeDepState and a RealDom struct. The ChildDepState, ParentDepState, and NodeDepState provide a way to describe how some information in a node relates to that of its relatives. By providing how to build a single node from its relations, native-core will derive a way to update the state of all nodes for you with ```#[derive(State)]```. Once you have a state you can provide it as a generic to RealDom. RealDom provides all of the methods to interact and update your new dom.
|
|
|
+To help in building a Dom, native-core provides the State trait and a RealDom struct. The State trait provides a way to describe how states in a node depend on other states in its relatives. By describing how to update a single node from its relations, native-core will derive a way to update the states of all nodes for you. Once you have a state you can provide it as a generic to RealDom. RealDom provides all of the methods to interact and update your new dom.
|
|
|
|
|
|
-```rust
|
|
|
-use dioxus_native_core::node_ref::*;
|
|
|
-use dioxus_native_core::state::{ChildDepState, NodeDepState, ParentDepState, State};
|
|
|
-use dioxus_native_core_macro::{sorted_str_slice, State};
|
|
|
-
|
|
|
-#[derive(Default, Copy, Clone)]
|
|
|
-struct Size(f32, f32);
|
|
|
-// Size only depends on the current node and its children, so it implements ChildDepState
|
|
|
-impl ChildDepState for Size {
|
|
|
- // Size accepts a font size context
|
|
|
- type Ctx = f32;
|
|
|
- // Size depends on the Size part of each child
|
|
|
- type DepState = Self;
|
|
|
- // Size only cares about the width, height, and text parts of the current node
|
|
|
- const NODE_MASK: NodeMask =
|
|
|
- NodeMask::new_with_attrs(AttributeMask::Static(&sorted_str_slice!(["width", "height"]))).with_text();
|
|
|
- fn reduce<'a>(
|
|
|
- &mut self,
|
|
|
- node: NodeView,
|
|
|
- children: impl Iterator<Item = &'a Self::DepState>,
|
|
|
- ctx: &Self::Ctx,
|
|
|
- ) -> bool
|
|
|
- where
|
|
|
- Self::DepState: 'a,
|
|
|
- {
|
|
|
- let mut width;
|
|
|
- let mut height;
|
|
|
- if let Some(text) = node.text() {
|
|
|
- // if the node has text, use the text to size our object
|
|
|
- width = text.len() as f32 * ctx;
|
|
|
- height = *ctx;
|
|
|
- } else {
|
|
|
- // otherwise, the size is the maximum size of the children
|
|
|
- width = children
|
|
|
- .by_ref()
|
|
|
- .map(|item| item.0)
|
|
|
- .reduce(|accum, item| if accum >= item { accum } else { item })
|
|
|
- .unwrap_or(0.0);
|
|
|
-
|
|
|
- height = children
|
|
|
- .map(|item| item.1)
|
|
|
- .reduce(|accum, item| if accum >= item { accum } else { item })
|
|
|
- .unwrap_or(0.0);
|
|
|
- }
|
|
|
- // if the node contains a width or height attribute it overrides the other size
|
|
|
- for a in node.attributes(){
|
|
|
- match a.name{
|
|
|
- "width" => width = a.value.as_float32().unwrap(),
|
|
|
- "height" => height = a.value.as_float32().unwrap(),
|
|
|
- // because Size only depends on the width and height, no other attributes will be passed to the member
|
|
|
- _ => panic!()
|
|
|
- }
|
|
|
- }
|
|
|
- // to determine what other parts of the dom need to be updated we return a boolean that marks if this member changed
|
|
|
- let changed = (width != self.0) || (height != self.1);
|
|
|
- *self = Self(width, height);
|
|
|
- changed
|
|
|
- }
|
|
|
-}
|
|
|
+Native Core cannot create all of the required methods for the State trait, but it can derive some of them. To implement the State trait, you must implement the following methods and let the `#[partial_derive_state]` macro handle the rest:
|
|
|
|
|
|
-#[derive(Debug, Clone, Copy, PartialEq, Default)]
|
|
|
-struct TextColor {
|
|
|
- r: u8,
|
|
|
- g: u8,
|
|
|
- b: u8,
|
|
|
-}
|
|
|
-// TextColor only depends on the current node and its parent, so it implements ParentDepState
|
|
|
-impl ParentDepState for TextColor {
|
|
|
- type Ctx = ();
|
|
|
- // TextColor depends on the TextColor part of the parent
|
|
|
- type DepState = Self;
|
|
|
- // TextColor only cares about the color attribute of the current node
|
|
|
- const NODE_MASK: NodeMask = NodeMask::new_with_attrs(AttributeMask::Static(&["color"]));
|
|
|
- fn reduce(
|
|
|
- &mut self,
|
|
|
- node: NodeView,
|
|
|
- parent: Option<&Self::DepState>,
|
|
|
- _ctx: &Self::Ctx,
|
|
|
- ) -> bool {
|
|
|
- // TextColor only depends on the color tag, so getting the first tag is equivilent to looking through all tags
|
|
|
- let new = match node.attributes().next().map(|attr| attr.name) {
|
|
|
- // if there is a color tag, translate it
|
|
|
- Some("red") => TextColor { r: 255, g: 0, b: 0 },
|
|
|
- Some("green") => TextColor { r: 0, g: 255, b: 0 },
|
|
|
- Some("blue") => TextColor { r: 0, g: 0, b: 255 },
|
|
|
- Some(_) => panic!("unknown color"),
|
|
|
- // otherwise check if the node has a parent and inherit that color
|
|
|
- None => match parent {
|
|
|
- Some(parent) => *parent,
|
|
|
- None => Self::default(),
|
|
|
- },
|
|
|
- };
|
|
|
- // check if the member has changed
|
|
|
- let changed = new != *self;
|
|
|
- *self = new;
|
|
|
- changed
|
|
|
- }
|
|
|
-}
|
|
|
+```rust, ignore
|
|
|
+{{#include ../../../examples/custom_renderer.rs:derive_state}}
|
|
|
+```
|
|
|
|
|
|
-#[derive(Debug, Clone, PartialEq, Default)]
|
|
|
-struct Border(bool);
|
|
|
-// TextColor only depends on the current node, so it implements NodeDepState
|
|
|
-impl NodeDepState<()> for Border {
|
|
|
- type Ctx = ();
|
|
|
-
|
|
|
- // Border does not depended on any other member in the current node
|
|
|
- const NODE_MASK: NodeMask =
|
|
|
- NodeMask::new_with_attrs(AttributeMask::Static(&["border"]));
|
|
|
- fn reduce(&mut self, node: NodeView, _sibling: (), _ctx: &Self::Ctx) -> bool {
|
|
|
- // check if the node contians a border attribute
|
|
|
- let new = Self(node.attributes().next().map(|a| a.name == "border").is_some());
|
|
|
- // check if the member has changed
|
|
|
- let changed = new != *self;
|
|
|
- *self = new;
|
|
|
- changed
|
|
|
- }
|
|
|
-}
|
|
|
+Lets take a look at how to implement the State trait for a simple renderer.
|
|
|
|
|
|
-// State provides a derive macro, but anotations on the members are needed in the form #[dep_type(dep_member, CtxType)]
|
|
|
-#[derive(State, Default, Clone)]
|
|
|
-struct ToyState {
|
|
|
- // the color member of it's parent and no context
|
|
|
- #[parent_dep_state(color)]
|
|
|
- color: TextColor,
|
|
|
- // depends on the node, and no context
|
|
|
- #[node_dep_state()]
|
|
|
- border: Border,
|
|
|
- // depends on the layout_width member of children and f32 context (for text size)
|
|
|
- #[child_dep_state(size, f32)]
|
|
|
- size: Size,
|
|
|
-}
|
|
|
+```rust
|
|
|
+{{#include ../../../examples/custom_renderer.rs:state_impl}}
|
|
|
```
|
|
|
|
|
|
-Now that we have our state, we can put it to use in our dom. Re can update the dom with update_state to update the structure of the dom (adding, removing, and chaning properties of nodes) and then apply_mutations to update the ToyState for each of the nodes that changed.
|
|
|
+Now that we have our state, we can put it to use in our RealDom. We can update the RealDom with apply_mutations to update the structure of the dom (adding, removing, and changing properties of nodes) and then update_state to update the States for each of the nodes that changed.
|
|
|
+
|
|
|
```rust
|
|
|
-fn main(){
|
|
|
- fn app(cx: Scope) -> Element {
|
|
|
- cx.render(rsx!{
|
|
|
- div{
|
|
|
- color: "red",
|
|
|
- "hello world"
|
|
|
- }
|
|
|
- })
|
|
|
- }
|
|
|
- let vdom = VirtualDom::new(app);
|
|
|
- let rdom: RealDom<ToyState> = RealDom::new();
|
|
|
-
|
|
|
- let mutations = dom.rebuild();
|
|
|
- // update the structure of the real_dom tree
|
|
|
- let to_update = rdom.apply_mutations(vec![mutations]);
|
|
|
- let mut ctx = AnyMap::new();
|
|
|
- // set the font size to 3.3
|
|
|
- ctx.insert(3.3f32);
|
|
|
- // update the ToyState for nodes in the real_dom tree
|
|
|
- let _to_rerender = rdom.update_state(&dom, to_update, ctx).unwrap();
|
|
|
-
|
|
|
- // we need to run the vdom in a async runtime
|
|
|
- tokio::runtime::Builder::new_current_thread()
|
|
|
- .enable_all()
|
|
|
- .build()?
|
|
|
- .block_on(async {
|
|
|
- loop{
|
|
|
- let wait = vdom.wait_for_work();
|
|
|
- let mutations = vdom.work_with_deadline(|| false);
|
|
|
- let to_update = rdom.apply_mutations(mutations);
|
|
|
- let mut ctx = AnyMap::new();
|
|
|
- ctx.insert(3.3);
|
|
|
- let _to_rerender = rdom.update_state(vdom, to_update, ctx).unwrap();
|
|
|
-
|
|
|
- // render...
|
|
|
- }
|
|
|
- })
|
|
|
-}
|
|
|
+{{#include ../../../examples/custom_renderer.rs:rendering}}
|
|
|
```
|
|
|
|
|
|
## Layout
|
|
|
-For most platforms the layout of the Elements will stay the same. The layout_attributes module provides a way to apply html attributes to a stretch layout style.
|
|
|
+
|
|
|
+For most platforms, the layout of the Elements will stay the same. The [layout_attributes](https://docs.rs/dioxus-native-core/latest/dioxus_native_core/layout_attributes/index.html) module provides a way to apply HTML attributes a [Taffy](https://docs.rs/taffy/latest/taffy/index.html) layout style.
|
|
|
+
|
|
|
+## Text Editing
|
|
|
+
|
|
|
+To make it easier to implement text editing in rust renderers, `native-core` also contains a renderer-agnostic cursor system. The cursor can handle text editing, selection, and movement with common keyboard shortcuts integrated.
|
|
|
+
|
|
|
+```rust
|
|
|
+{{#include ../../../examples/custom_renderer.rs:cursor}}
|
|
|
+```
|
|
|
|
|
|
## Conclusion
|
|
|
-That should be it! You should have nearly all the knowledge required on how to implement your own renderer. We're super interested in seeing Dioxus apps brought to custom desktop renderers, mobile renderer, video game UI, and even augmented reality! If you're interesting in contributing to any of the these projects, don't be afraid to reach out or join the community.
|
|
|
+
|
|
|
+That should be it! You should have nearly all the knowledge required on how to implement your renderer. We're super interested in seeing Dioxus apps brought to custom desktop renderers, mobile renderers, video game UI, and even augmented reality! If you're interested in contributing to any of these projects, don't be afraid to reach out or join the [community](https://discord.gg/XgGxMSkvUM).
|