Skip to content

Latest commit

 

History

History
66 lines (56 loc) · 2.28 KB

README.md

File metadata and controls

66 lines (56 loc) · 2.28 KB

cache-element stability

npm version build status downloads js-standard-style

Cache an HTML element that's used in DOM diffing algorithms that respect element.isSameNode().

Usage

var cache = require('cache-element')
var html = require('bel')

var nav = cache(function () {
  return html`
    <nav>
      <div>All content</div>
      <div>In here</div>
      <div>Is static</div>
      <div>And doesn't need to be diffed</div>
      <div>On every render</div>
    </nav>
  `
})

document.body.appendChild(nav.render())

API

element = cache(render)

Create a new instance of cache-element. Takes a render function that is called when element.render() is called and a prior call doesn't have a node mounted on the DOM.

element.render()

Render the element to append it on the DOM. As long as the Node is on the DOM, subsequent calls to element.render() will return an empty node that has a .isSameNode() method on it so diffing algorithms that respect this property will skip diffing this node.

Installation

$ npm install cache-element

See Also

License

MIT