dom-batch

0.3.1 • Public • Published

dom-batch Build Status

Eliminates layout thrashing by batching DOM read/write interactions.

var dom = new DomBatch();
 
dom.read(function() {
  console.log('<DOM Read>');
});
 
dom.write(function() {
  console.log('<DOM Write>');
});
 
dom.read(function() {
  console.log('<DOM Read>');
});
 
dom.write(function() {
  console.log('<DOM Write>');
});
 
// Output:
 
<DOM Read>
<DOM Read>
<DOM Write>
<DOM Write>

API

DomBatch#read(callback[, context])

Schedules a task for the 'read' queue.

dom.read(function() {
  var width = element.clientWidth;
});

DomBatch#write(callback[, context])

Schedules a task for the 'write' queue.

dom.write(function() {
  element.style.width = width + 'px';
});

DomBatch#clearRead(callback)

Removes a task from the 'read' queue.

var fn = function(){};
 
dom.read(fn);
dom.clearRead(fn);

DomBatch#clearWrite(callback)

Removes a task from the 'write' queue.

var fn = function(){};
 
dom.write(fn);
dom.clearWrite(fn);

Tests

With PhantomJS

$ npm install
$ npm test

Without PhantomJS

$ node_modules/.bin/buster-static

...then visit http://localhost:8282/ in browser

Author

Contributors

Readme

Keywords

none

Package Sidebar

Install

npm i dom-batch

Weekly Downloads

1

Version

0.3.1

License

MIT

Last publish

Collaborators

  • wilsonpage