npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ember-batcher

v5.0.0

Published

Ember addon providing requestAnimationFrame utilities to properly batch reads/writes within Embers runloop.

Downloads

6,318

Readme

ember-batcher

CI Build Ember Observer Score npm version Monthly Downloads from NPM Code Style: prettier

An Ember addon to batch DOM reads and mutations using requestAnimationFrame.

As noted in Paul Irish's "What Forces Layout", a number of properties or methods, when requested/called, will trigger the browser to sychronously calculate the style and layout. This is also called reflow or layout thrashing, and is common performance bottleneck. This addon attempts to provide a mechanism to compliment Ember's runloop batching to help minimize layout thrashing.

Compatibility

  • Ember.js v3.24 or above
  • Ember CLI v3.24 or above
  • Node.js v14 or above

Installation

ember install ember-batcher

Usage

readDOM(readTask: Function): void

Register a task function that will get batched with other "reads" and called on the next requestAnimationFrame (if supported). The method will be executed within either the current run loop or will create a new run loop if necessary.

import Component from '@glimmer/component';
import { readDOM } from 'ember-batcher';

export default class MyComponent extends Component {
  foo() {
    readDOM(() => {
      // Perform DOM read
    });
  }
}

mutateDOM(mutationTask: Function): void

Register a task function that will get batched with other "mutations" and before other "reads". The method will be called on the next requestAnimationFrame (if supported). The method will be executed within either the current run loop or will create a new run loop if necessary.

import Component from '@glimmer/component';
import { mutateDOM } from 'ember-batcher';

export default class MyComponent extends Component {
  foo() {
    mutateDOM(() => {
      // Perform DOM mutation
    });
  },
}

Reads, then Writes

Since the purpose of this addon is to minimize layout thrashing, we want to perform all reads before we perform writes. Additionally, you should close over values created during the read phase that are used in the write phase. This helps ensure that work doesn't leak outside of the frame we're performing the work in, and allows you to prepare values in the read phase that are used in the subsequent write phase.

To be clear, writes should not occur during the reads phase, therefore you should not have any code that performs any reads from within the callback of readDOM. All writes should occur inside a call to mutateDOM, whether that's in a non-nested call to _mutateDOM itself, or from a nested call to mutateDOM inside of a readDOM call.

Example of read first, then write.

import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';
import { readDOM, mutateDOM } from 'ember-batcher';

export default class MyComponent extends Component {
  @tracked
  width;

  foo() {
    readDOM(() => {
      const width = document.querySelector('.foo').clientWidth;

      mutateDOM(() => {
        // we should perform our update conditionally, only if the value of width changes. This helps
        // minimize unnecessary layout thrashing.
        if (this.width !== width) {
          this.width = width * 2;
        }
      });
    });
  },
}

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.