Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@shopify/react-idle

Package Overview
Dependencies
Maintainers
17
Versions
82
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@shopify/react-idle

Utilities for working with idle callbacks in React

  • 2.1.7
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
19K
increased by50.26%
Maintainers
17
Weekly downloads
 
Created
Source

@shopify/react-idle

Build Status Build Status License: MIT npm version npm bundle size (minified + gzip)

Utilities for working with idle callbacks in React.

Installation

$ yarn add @shopify/react-idle

Usage

This library provides a hook (useIdleCallback) and a component (OnIdle) for registering a callback to run in the next idle callback.

Note: this callback is not called with any arguments, unlike direct usage of requestIdleCallback. This makes it more suited for use with discrete operations, rather than ones that will need to schedule themselves for subsequent idle callbacks if the work has not been completed.

import {useCallback} from 'react';
import {useIdleCallback, OnIdle} from '@shopify/react-idle';

function MyComponent() {
  const callback = useCallback(() => {
    console.log('Hello from an idle callback!');
  }, []);

  useIdleCallback(callback);

  // or

  return <OnIdle perform={callback} />;
}

If the callback ever changes, or the component unmounts, the original callback will not be run.

UnsupportedBehavior

Because not every browser supports idle callbacks, this library allows you to specify the behavior of perform when requestIdleCallback is not present. There are currently two options (each of which can be passed as an unsupportedBehavior option for the hook, or an unsupportedBehavior prop of the component):

  • UnsupportedBehavior.AnimationFrame (default): run the callback in the next animation frame using requestAnimationFrame.
  • UnsupportedBehavior.Immediate: run the callback immediately on mount.
import {useIdleCallback, UnsupportedBehavior} from '@shopify/react-idle';

function MyComponent() {
  useIdleCallback(doSomethingThatCanBeDeferred, {
    unsupportedBehavior: UnsupportedBehavior.Immediate,
  });

  return null;
}

Additional types

Because the typings for requestIdleCallback are not yet provided by the TypeScript standard library, this module also exports a number of types that are needed to interact with these globals.

FAQs

Package last updated on 01 Dec 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc