JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 219609
  • Score
    100M100P100Q173618F
  • License MIT

A React hook for throttling setState and other callbacks

Package Exports

  • @react-hook/throttle

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@react-hook/throttle) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme


useThrottle()

Bundlephobia Types NPM Version MIT License

npm i @react-hook/throttle

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: any, fps?: number, leading?: boolean)

Options

Property Type Default Description
initialState any The initial state stored in 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 any The value set by setState or the initialState
setState Function A throttled setState callback

useThrottleCallback(callback: Function, wait?: number, leading?: boolean)

Options

Property Type Default Description
callback Function This is the callback you want to throttle
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 Function A throttled version of your callback

LICENSE

MIT