Skip to content
This repository has been archived by the owner on May 19, 2023. It is now read-only.

Commit

Permalink
docs: add table of contents to vdom readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aidenybai committed Nov 27, 2020
1 parent e8e96f4 commit 1357e6c
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions src/vdom/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
- [Virtual DOM Documentation](#virtual-dom-documentation)
- [Design principles](#design-principles)
- [Overview](#overview)
- [Compile phase](#compilation-phase)
- [Patching phase](#patching-phase)
- [Watching phase](#watching-phase)

# Virtual DOM Documentation

This document covers how Lucia's Virtual DOM works. It's intended to aid in understanding the code, ad helping contributors work with it.
Expand All @@ -22,8 +29,7 @@ The Lucia Virtual DOM is designed to accomplish a balance between being **fast a

## Overview

![Flowchart Overview](https://chart.googleapis.com/chart?cht=gv&chl=graph{VDOM--Compiler[type=s];VDOM--Patcher[type=s];VDOM--Observer[type=s];Observer--Patch_if_necessary[type=s];}
)
![Flowchart Overview](https://chart.googleapis.com/chart?cht=gv&chl=graph{Virtual_DOM--Compile[type=s];Virtual_DOM--Patch[type=s];Virtual_DOM--Watch[type=s];})

### Compilation phase

Expand Down Expand Up @@ -65,7 +71,7 @@ This phase takes compiled VNodes and a mutable view, traversig the tree and rend
attributes: {},
directives: {
+ text: 'old',
- text: 'new',
- text: 'new',
},
ref: <HTMLElement>,
type: 2,
Expand Down

0 comments on commit 1357e6c

Please sign in to comment.