-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4542630
commit 916cedb
Showing
1 changed file
with
14 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,18 @@ | ||
virtual-dom documentation WIP | ||
==================== | ||
[VNode](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/vnode.md) | ||
# virtual-dom documentation | ||
virtual-dom consists of two modules: [vtree](https://github.com/Matt-Esch/vtree), which is responsible for diffing two virtual representations DOM nodes, and [vdom](https://github.com/Matt-Esch/vdom), which is responsible for taking the patch object genereated by [vtree/diff](https://github.com/Matt-Esch/vtree/blob/master/diff.js) and modifying the DOM (using [vdom/patch](https://github.com/Matt-Esch/vdom/blob/master/patch.js)). | ||
|
||
[VText](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/vtext.md) | ||
This documentation is aimed at people who would like to work with virtual-dom directly, or gain a deeper understanding of how their virtual-dom based framework works. If you would rather be working at a higher level, you may find the [mercury framework](https://github.com/Raynos/mercury) a better place to start. | ||
|
||
[Hooks](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/hooks.md) | ||
Newcomers should start by reading the VNode and VText documentation, as virtual nodes are central to the operation of virtual-dom. Hooks, Thunks, and Widgets are more advanced features, and you will find both documentation of their interfaces and several examples on their respective pages. | ||
|
||
[Thunk](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/thunk.md) | ||
## Contents | ||
|
||
[Widget](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/widget.md) | ||
[VNode](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/vnode.md) - A representation of a DOM element | ||
|
||
[VText](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/vtext.md) - A representation of a text node | ||
|
||
[Hooks](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/hooks.md) - The mechanism for executing functions after a new node has been created | ||
|
||
[Thunk](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/thunk.md) - The mechanism for taking control of diffing a specific DOM sub-tree | ||
|
||
[Widget](https://github.com/littleloops/virtual-dom-docs-wip/blob/master/widget.md) - The mechanism for taking control of node patching: DOM Element creation, updating, and removal. |