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

@modus/react-idle

v1.1.1

Published

Render components when browser is idle

Downloads

1,044

Readme

React Idle

CircleCI Maintainability MIT Licensed Enterprise Web Development

Render components when browser is idle.

The idea is to allow Above The Fold content to render as soon as possible, letting the rest of the app render and update when the browser is idle.

This component uses requestAnimationFrame which is also used in React.

Demo

See a working react-idle demo and compare rendering performance between syncronous rendering and rendering on idle.

Getting started

Install react-idle using npm.

npm install @modus/react-idle --save

Usage

import * as React from 'react';
import OnIdle from '@modus/react-idle';

export default class MyView extends React.Component {
  render() {
    <section>
      <article>This is above the fold content that must render ASAP</article>
      <OnIdle>
        <aside>This heavy component can be rendered when the browser is idle</aside>
      </OnIdle>
    </section>
  }
}

Dependencies

React Idle has only one direct dependency: idlize. Since it's meant to be used with React, it expects that your project already depends on react and react-dom.

NPM will not automatically install these dependencies for you, but it will show a friendly warning message with instructions.

Configuration

| Property | Type | Required? | Description | |:---|:---|:---:|:---| | children | React Node | ✓ | Children you want to render on idle | | placeholder | React Node | | Placeholder component that shows before the render takes place | | onRender | Function | | Callback executed after render completes. No arguments provided. | | skipSSR | Boolean | | Use this property to prevent the children from being rendered in Server Side Rendering. Defaults to false. | | syncUpdate | Boolean | | Use this property to render updates immediately instead of triggering another onIdle process. Defaults to false. |

Contributing

Testing

This project uses Jest for unit testing. To execute tests run this command:

npm test

It's useful to run tests in watch mode when developing for incremental updates.

npm run test:watch

License

This project is MIT licensed.