Naughty Program Manipulator
Have ideas to improve npm?Join in the discussion! »

morphjam

1.0.1 • Public • Published

morphjam

npm version downloads js-standard-style

Hyper fast diffing algorithm for real DOM nodes ⚡️

Usage

var morph = require('morphjam')
var html = require('bel')
 
var tree = html`<div>hello people</div>`
document.body.appendChild(tree)
// document.body === <body><div>hello people</div></body>
 
morph(tree, html`<div>nanananana-na-no</div>`)
// document.body === <body><div>nanananana-na-no</div></body>
 
morph(tree, html`<div>teeny, tiny, tin bottle</div>`)
// document.body === <body><div>teeny, tiny, tin bottle</div></body>

Clearing Input Values

To remove values from inputs, there's a few options:

html`<input class="beep" value=${null}>` // set the value to null
html`<input class="beep">`               // omit property all together

Reordering Lists

It's common to work with lists of elements on the DOM. Adding, removing or reordering elements in a list can be rather expensive. To optimize this you can add an id attribute to a DOM node. When reordering nodes it will compare nodes with the same ID against each other, resulting in far fewer re-renders. This is especially potent when coupled with DOM node caching.

var el = html`
  <section>
    <div id="first">hello</div>
    <div id="second">world</div>
  </section>
`

Caching DOM elements

Sometimes we want to tell the algorithm to not evaluate certain nodes (and its children). This can be because we're sure they haven't changed, or perhaps because another piece of code is managing that part of the DOM tree. To achieve this morphjam evaluates the .isSameNode() method on nodes to determine if they should be updated or not.

var el = html`<div>node</div>`
 
// tell morphjam to not compare the DOM tree if they're both divs
el.isSameNode = function (target) {
  return (target && target.nodeName && target.nodeName === 'DIV')
}

FAQ

How is this different from morphdom?

It's quite similar actually; the API of this library is completely compatible with morphdom and we've borrowed a fair few bits. The main difference is that we copy event handlers like onclick, don't support browsers that are over a decade old, and don't provide custom behavior by removing all hooks. This way we can guarantee a consistent, out-of-the box experience for all your diffing needs.

How is this different from nanomorph?

This is a fork of the choojs project nanomorph, however we have a few differences. Events are determined no longer a hard-coded list, but are determined by a function you provide. We've also changed some of the logic to be less nuanced about namespaces. This shares most of the same test suite.

How is this different from tatermorph?

So far, it's the same package, only renamed and a removed dep on the assert package that was being auto-included in projects. However, this will only grow as time goes on as it becomes more integrated with the astate project.

This library seems cool, I'd like to build my own!

morphjam was optimized for simplicity, but different situations might require different tradeoffs. So in order to allow folks to build their own implementation we expose our test suite as a function you can call. So regardless if you're doing it to solve a problem, or just for fun: you can use the same tests we use for your own implementation. Yay! ✨

API

tree = morphjam(oldTree, newTree, getEvents)

Diff a tree of HTML elements against another tree of HTML elements and create a patched result that can be applied on the DOM.

⚠️ morphjam will modify the newTree and it should be discarded after use

getEvents is a function which takes in a newNode and oldNode, and returns a list of events. It is an optional parameter, and can (in the similest case) return a hardcoded list of events you are watching for. In more complicated scenarios, you can query for events for both the new and old element.

Installation

$ npm install morphjam

See Also

Similar Packages

Further Reading

Original Authors

Original License

MIT

Install

npm i morphjam

DownloadsWeekly Downloads

3

Version

1.0.1

License

MIT

Unpacked Size

314 kB

Total Files

10

Last publish

Collaborators

  • avatar