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

@react-hook/throttle

v2.2.0

Published

A React hook for throttling setState and other callbacks

Downloads

804,254

Readme

A React hook for performantly throttling setState and other callbacks.

Quick Start

import {useThrottle, useThrottleCallback} from '@react-hook/throttle'

const Component = (props) => {
  // at a basic level, used just like useState
  const [value, setValue] = useThrottle('initialValue')
}

const useMyCallback = (initialState, wait, leading) => {
  // this is the same code useThrottle() uses to throttle setState
  const [state, setState] = useState(initialState)
  return [state, useThrottleCallback(setState, wait, leading)]
}

API

useThrottle(initialState, fps?, leading?)

A hook that acts just like React.useState, but with a setState function that is only invoked at most X frames per second. A trailing call is guaranteed, but you may opt-in to calling on the leading edge, as well.

export const useThrottle = <State>(
  initialState: State | (() => State),
  fps?: number,
  leading?: boolean
): [State, Dispatch<SetStateAction<State>>]

Arguments

| Property | Type | Default | Description | | ------------ | ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | | initialState | State | (() => State) | | The initial state provided to React.useState() | | fps | number | 30 | Defines the rate in frames per second with which setState is invoked with new state | | leading | boolean | false | Calls setState on the leading edge (right away). When false, setState will not be called until the next frame is due |

Returns [state, setState]

| Variable | Type | Description | | -------- | --------------------------------- | ------------------------------- | | state | State | The current value in state | | setState | Dispatch<SetStateAction<State>> | A throttled setState callback |


useThrottleCallback(callback, fps?, leading?)

A hook that invokes its callback at most X frames per second. A trailing call is guaranteed, but you may opt-in to calling on the leading edge, as well.

export const useThrottleCallback = <Callback extends (...args: any[]) => void>(
  callback: Callback,
  fps = 30,
  leading = false
): Callback

Arguments

| Property | Type | Default | Description | | -------- | ----------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | callback | ((...args: CallbackArgs) => void) | | This is the callback you want to throttle. You need to wrap closures/unstable callbacks in useCallback() so that they are stable, otherwise throttling will break between renders. | | fps | number | 30 | Defines the rate in frames per second with which setState is invoked with new state | | leading | boolean | false | Calls setState on the leading edge (right away). When false, setState will not be called until the next frame is due |

Returns throttledCallback

| Variable | Type | Description | | ----------------- | ----------------------------------- | ------------------------------------ | | throttledCallback | ((...args: CallbackArgs) => void) | A throttled version of your callback |

LICENSE

MIT