react-throttle

    0.3.0 • Public • Published

    react-throttle

    Build Status codecov.io Dependency Status devDependency Status bitHound Overall Score Known Vulnerabilities

    react-throttle is an npm package which contains two React components: Throttle and Debounce. These components can be wrapped around a child component, the event handlers of which will be either throttled or debounced depending on which component you choose.

    Problem

    Oftentimes, events are fired more often than we really care about. For example, when scrolling down a page, the onScroll event will fire many times per second. If our event handler is even slightly complex, this will result in jank.

    Pages which employ incremental searches are quite common on the Web. Typically an <input> element is used with an onChange handler, which sends an XHR to the server to request results. If the user is typing quickly, we don't want to bombard the server with a request for each keystroke, as this is a waste of resources.

    Solution

    By throttling or debouncing our event handlers, we can dramatically reduce the amount of times the handler is called. By using these methods, we are able to choose the frequency with which we respond to events.

    There are two methods by which we can lower the frequency of our event handler calls:

    • Throttling

      This method revolves around a time interval. For example, by specifying a time interval of 100ms, this will ensure that the event handler is not called more than once per 100 milliseconds. This is handy for use cases such as the scrolling example above, where the handler may be called dozens of times in a 100 millisecond timeframe. Using the throttling method, we drastically cut down how often the handler is called.

    • Debouncing

      Sometimes we only want to respond to an input when it is, or seems to be, complete. Again, we specify a time interval, but this time it has a different meaning. If we specify 100ms in this case, it means that our event handler will only be called if at least 100ms have passed since the last event. In the case of the incremental search box, this means that the typed input will only be processed 100ms after the user's last keystroke.

    Usage

    The components are both used in a similar manner:

    Throttle

    import { Throttle } from 'react-throttle';
     
    <Throttle time="200" handler="onChange">
        <input onChange={() => console.log('input')} />
    </Throttle>

    Debounce

    import { Debounce } from 'react-throttle';
     
    <Debounce time="400" handler="onChange">
        <input onChange={() => console.log('input')} />
    </Debounce>

    Both these components take a prop called handler which specifies the handler on the child component to throttle or debounce. An array of handler names can also be passed through handlers if the need arises.

    License

    MIT

    Bug Reports

    Please file bug reports using GitHub issues. Thank you!

    Pull Requests

    If you would like to contribute to this project, feel free. Clean, well-tested, well-documented code is appreciated. Thanks!

    Install

    npm i react-throttle

    DownloadsWeekly Downloads

    3,697

    Version

    0.3.0

    License

    MIT

    Last publish

    Collaborators

    • gmcquistin