npmpackage.info

Gathering detailed insights and metrics for skatejs-dom-diff

skatejs-dom-diff - 1.0.1 | npmpackage.info

skatejs-dom-diff

Library for efficiently diffing and patching virtual and real DOM fragments.

1.0.1

100

MIT

JavaScript

28.66 kB

2.8

Installations

npm install skatejs-dom-diff

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.4.0

NPM Version

5.3.0 Pull Requests

Open

0

Total

115

Closed

90

Merged

25

Issues

Open

6

Total

18

Closed

12

Releases

v1.0.0

Updated on Dec 10, 2016

v0.4.2

Updated on Nov 19, 2016

v0.4.1

Updated on Nov 19, 2016

v0.4.0

Updated on Nov 19, 2016

View All 4 releases

Languages

JavaScript

JavaScript (100%)

Developer

skatejs

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

100 Stars

239 Commits

7 Forks

7 Watchers

21 Branches

7 Contributors

Updated on Jan 05, 2025

Maintainers

View All 7 Contributors

Package Meta Information

Latest Version

1.0.1

Package Id

skatejs-dom-diff@1.0.1

Unpacked Size

28.66 kB

Size

9.28 kB

File Count

NPM Version

5.3.0

Node Version

8.4.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

custom-event-polyfill cz-conventional-changelog semantic-release skatejs-build skatejs-web-components worker-loader

Dom Diff

Skate's DOM Diff is a virtual DOM library for diffing, patching and converting between virtual and real DOM trees.

Serialise to and from read DOM trees
Diff virtual trees and patch real trees
Web worker support

1npm install skatejs-dom-diff

Usage

Where options are accepted, you may provide:

done If specified, diffing is performed in a web worker and this callback is called when it's done.

`diff(source, target, options)`

Diffs two virtual trees.

1/** @jsx h **/
2import { diff, h } from 'skatejs-dom-diff';
3
4const source = <div><span>source</span></div>;
5const target = <div><span>target</span></div>;
6const instructions = diff(source, target);

The patchInstructions is an array that can be passed to patch() to update the source tree. Before passing the instructions to patch(), however, your source tree must be associated to real DOM nodes. This can be done by using mount() or by converting them to a tree using toDom().

`fragment([virtualNodeOrNodes])`

Creates a virtual fragment. You can pass nothing to create an empty fragment:

1import { fragment } from 'skatejs-dom-diff';
2
3const vFrag = fragment();

A single virtual node:

1import { fragment } from 'skatejs-dom-diff';
2
3const vFrag = fragment(<div />);

An array of virtual nodes:

1import { fragment } from 'skatejs-dom-diff';
2
3const vFrag = fragment([<div />, <span />]);

Or even a virtual fragment:

1import { fragment } from 'skatejs-dom-diff';
2
3const vFrag = fragment(fragment(<div />));

`h(name, props, ...childrenOrText)`

Creates a virtual node.

1// <div class="my-class">text or...<span /></div>
2h('div', { className: 'my-class' }, 'text or...', h('span'));

Or you could just use JSX:

1/** @jsx h **/
2// <div class="my-class">text or...<span /></div>
3<div className="my-class">text or...<span /></div>

Attributes

By default, h only sets properties, but you can specify attributes you want to set by passing the special attributes prop:

1// <div class="my-class" />
2<div attributes={{ class: 'my-class' }} />

Aria attributes

You can pass aria-* attributes using attributes but you can also specify the aria prop:

1// <div aria-label="my label" />
2<div aria={{ label: 'my label' }} />

Data attributes

Like the aria prop, you can also use the data prop:

1// <div data-something="my data" />
2<div data={{ something: 'my data' }} />

Events

Events are bound using the special events prop:

1const click = e => doSomethingWith(e);
2<div events={{ click }} />

`merge()`

The merge() function is convenience for calling diff() and patch() sequentially. As with diff(), you must ensure the source virtual tree has been associated to real nodes first.

1/** @jsx h **/
2import { diff, h } from 'skatejs-dom-diff';
3
4const source = <div><span>source</span></div>;
5const target = <div><span>target</span></div>;
6const dom = mount(source);
7merge(source, target);

`mount(vdom[, root])`

Mounts the vdom to the real root DOM node. It returns the root node. If the root node was not specified, it automatically creates a <div /> and returns it.

1/** @jsx h **/
2import { h, mount } from 'skatejs-dom-diff';
3
4const div = mount(<p>some text</p>);

Is the same thing as:

1/** @jsx h **/
2import { h, mount } from 'skatejs-dom-diff';
3
4const div = document.createElement('div');
5mount(<p>some text</p>, div);

It's more than likely that you'll just mount it directly to the document:

1/** @jsx h **/
2import { h, mount } from 'skatejs-dom-diff';
3
4mount(<p>some text</p>, document.getElementById('app'));

`patch()`

Takes instructiosn created using diff() and performs them on the associated DOM nodes that each instructions is for.

1/** @jsx h **/
2import { diff, h, mount, patch } from 'skatejs-dom-diff';
3
4const source = <p>source tree</p>;
5const target = <p>target tree</p>;
6const instructions = diff(source, target);
7
8mount(source, document.getElementById('app'));
9patch(instructions);

`render()`

A highly convenient function for continually rendering a given template.

1/** @jsx h **/
2import { h, render } from 'skatejs-dom-diff';
3
4const root = document.getElementById('app');
5const renderer = render((root) => (
6  <p>{root.someProp}</p>
7));
8
9// Set the prop to render with
10root.someProp = 'test 1';
11
12// Initial render: <p>test 1</p>
13renderer(root);
14
15// Update the prop
16root.someProp = 'test 2';
17
18// Re-render: <p>test 2</p>
19renderer(root);

`text()`

Returns a virtual text node:

1import { text } from 'skatejs-dom-diff';
2
3const vText = text('my text node');

`toDom()`

Convers a virtual tree to a real DOM tree, event listeners and all:

1import { toDom } from 'skatejs-dom-diff';
2
3const vdom = <p>I will soon be real!</p>
4const dom = toDom(vdom);
5
6// <p>I will soon be real!</p>
7console.log(dom.outerHTML);

`toVdom()`

Converts a real DOM tree into a virtual tree. It only copies over attributes. Event listeners can't be copied because the standard DOM APIs don't provide a way to get bound listeners.

Properties currently aren't copied either, but is being worked on.

1import { toVdom } from 'skatejs-dom-diff';
2
3const dom = document.createElement('p');
4dom.textContent = 'I will soon be fake!';
5
6const vdom = toVdom(dom);

`types`

The types of patches that can occur. Currently these are:

1import { types } from 'skatejs-dom-diff';
2
3const {
4  APPEND_CHILD,
5  REMOVE_CHILD,
6  REMOVE_ATTRIBUTE,
7  REPLACE_CHILD,
8  SET_ATTRIBUTE,
9  SET_EVENT,
10  SET_PROPERTY,
11  TEXT_CONTENT
12} = types;

Web workers

You can tell the differ to do its work in a web worker simply by passing a done callback option to any of the three major entry functions (diff(), merge(), render()).

`diff(source, target, options)`

In the case of diff(), it's called once the diffing algorithm has finished in the worker and passed the instructions. The patch instructions are the only argument passed into the callback.

1/** @jsx h */
2import { h, diff } from 'skatejs-dom-diff';
3
4function done (instructions) {
5  patch(instructions);
6}
7diff(<p>source</p>, <p>target</p>, { done });

`merge(source, target, options)`

For done(), it's passed in the same exact way. The only difference is that it's called after the patch is performed but it's still passed the instructions that were performed by the patch algorithm.

1/** @jsx h */
2import { h, merge } from 'skatejs-dom-diff';
3
4function done (instructions) {
5  // The DOM has been updated, do what you want here.
6}
7merge(<p>source</p>, <p>target</p>, { done });

`render(source, target, options)`

And for render(), it is the same as the merge() function. So once the vDOM is rendered and DOM is patched, done() is called with the instructions that were performed.

1import { h, render } from 'skatejs-dom-diff';
2
3function done (instructions) {
4  // Renering and patching is done...
5}
6const root = document.createElement('div');
7const doRender = render((root) => (
8  <div>{root.test}</div>
9));
10
11div.test = 'initial text';
12doRender(div, done);
13
14div.test = 'updated text';
15doRender(div, done);

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

5

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

155 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-832h-xg76-4gv6
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c
Warn: Project is vulnerable to: GHSA-qh2h-chj9-jffq
Warn: Project is vulnerable to: GHSA-jcpv-g9rr-qxrc
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-8g7p-74h8-hg48
Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-4hpf-3wq7-5rpr
Warn: Project is vulnerable to: GHSA-f522-ffg8-j8r6
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-7x7c-qm48-pq9c
Warn: Project is vulnerable to: GHSA-rc3x-jf5g-xvc5
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-82v2-mx6x-wq7q
Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-hxm2-r34f-qmc5
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-7mc5-chhp-fmc3
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-ph34-pc88-72gc
Warn: Project is vulnerable to: GHSA-m6cx-g6qm-p2cx
Warn: Project is vulnerable to: GHSA-x8qc-rrcw-4r46
Warn: Project is vulnerable to: GHSA-4328-8hgf-7wjr
Warn: Project is vulnerable to: GHSA-93f3-23rq-pjfp
Warn: Project is vulnerable to: GHSA-pw54-mh39-w3hc
Warn: Project is vulnerable to: GHSA-xgh6-85xh-479p
Warn: Project is vulnerable to: GHSA-28xh-wpgr-7fm8
Warn: Project is vulnerable to: GHSA-q75g-2496-mxpp
Warn: Project is vulnerable to: GHSA-6fx8-h7jm-663j
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-gqgv-6jq5-jjj9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-7xfp-9c55-5vqj
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-r2j6-p67h-q639
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-fxwf-4rqh-v8g3
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-xfhh-g9f5-x4m4
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-xc7v-wxcw-j472
Warn: Project is vulnerable to: GHSA-v2p6-4mp7-3r9v
Warn: Project is vulnerable to: GHSA-46c4-8wrp-j99v
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-mgfv-m47x-4wqp
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-cf66-xwfp-gvc4
Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6663-c963-2gqg
Warn: Project is vulnerable to: GHSA-5v72-xg48-5rpm
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg
Warn: Project is vulnerable to: GHSA-3v6h-hqm4-2rg6
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-mpcf-4gmh-23w8
Warn: Project is vulnerable to: GHSA-9qj9-36jm-prpv
Warn: Project is vulnerable to: GHSA-pp57-mqmh-44h7
Warn: Project is vulnerable to: GHSA-wrvr-8mpx-r7pp
Warn: Project is vulnerable to: GHSA-pc58-wgmc-hfjr
Warn: Project is vulnerable to: GHSA-vvv8-xw5f-3f88
Warn: Project is vulnerable to: GHSA-57cf-349j-352g
Warn: Project is vulnerable to: GHSA-hxcm-v35h-mg2x
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-38h8-x697-gh8q
Warn: Project is vulnerable to: GHSA-pv4c-p2j5-38j4
Warn: Project is vulnerable to: GHSA-pjmx-9xr3-82qr

Score

2.8

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More