Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/livoras/simple-virtual-dom
Basic virtual-dom algorithm
https://github.com/livoras/simple-virtual-dom
Last synced: 28 days ago
JSON representation
Basic virtual-dom algorithm
- Host: GitHub
- URL: https://github.com/livoras/simple-virtual-dom
- Owner: livoras
- License: mit
- Created: 2015-11-19T06:06:10.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-12-08T06:13:46.000Z (almost 4 years ago)
- Last Synced: 2024-10-01T11:41:19.105Z (about 1 month ago)
- Language: JavaScript
- Size: 62.5 KB
- Stars: 1,721
- Watchers: 42
- Forks: 316
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
simple-virtual-dom
==============================
[](https://circleci.com/gh/livoras/simple-virtual-dom)
[](https://codecov.io/github/livoras/simple-virtual-dom?branch=master)
[](https://david-dm.org/livoras/simple-virtual-dom)
[](https://badge.fury.io/js/simple-virtual-dom)
[](https://github.com/feross/standard)
Simple virtual-dom algorithm. It has only ~500 lines of code, including very basic idea of virtual-dom algorithm.
**NOTE**: This is an experiment library, DO NOT use it in any serious productions.
## Install
npm:
$ npm install simple-virtual-dom --save
or checkout the `bundle.js` in `dist`:
## Usage
```javascript
var svd = require('simple-virtual-dom')
var el = svd.el
var diff = svd.diff
var patch = svd.patch
// 1. use `el(tagName, [propeties], children)` to create a virtual dom tree
var tree = el('div', {'id': 'container'}, [
el('h1', {style: 'color: blue'}, ['simple virtal dom']),
el('p', ['Hello, virtual-dom']),
el('ul', [el('li')])
])
// 2. generate a real dom from virtual dom. `root` is a `div` element
var root = tree.render()
// 3. generate another different virtual dom tree
var newTree = el('div', {'id': 'container'}, [
el('h1', {style: 'color: red'}, ['simple virtal dom']),
el('p', ['Hello, virtual-dom']),
el('ul', [el('li'), el('li')])
])
// 4. diff two virtual dom trees and get patches
var patches = diff(tree, newTree)
// 5. apply patches to real dom
patch(root, patches)
// now the `root` dom is updated
```
You can checkout the full example in `example` folder.
You should always provide a unique `key` property for each child in array(just like ReactJS's keyed children) for Virtual-DOM to reorder children instead of replacing the whole list when perform diff algorithm.
```javascript
var root = el('ul', [
el('li', {key: 'uid1'}, ['Jerry']),
el('li', {key: 'uid2'}, ['Tomy']),
el('li', {key: 'uid3'}, ['Lucy']),
])
var newRoot = el('ul', [
el('li', {key: 'uid1'}, ['Jerry']),
el('li', {key: 'uid2'}, ['Tomy']),
el('li', {key: 'uid4'}, ['Lily']),
el('li', {key: 'uid3'}, ['Lucy']),
])
// ensure `patches` is minimum
var patches = diff(root, newRoot)
```
## License
The MIT License (MIT)
Copyright (c) 2015 Livoras
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.