use-debouncy

useDebouncy

🌀Small (120 bytes) debounce effect hook for React with TypeScript support

Features

• 👌 No dependencies.
• 🏋️‍ Tiny. 120 bytes. Size Limit controls the size.
• 📖 Types. Support TypeScript.
• 🎣 Easy. Like useEffect hook.

Installation

# NPM
npm install use-debouncy

# YARN
yarn add use-debouncy

Examples

Demo codesandbox

import React, { useState } from 'react';
import useDebouncy from 'use-debouncy';

const App = () => {
  const [value, setValue] = useState('');

  useDebouncy(
    () => fetchData(value), // function debounce
    400, // number of milliseconds to delay
    [value], // array values that the debounce depends (like as useEffect)
  );

  return (
    <input value={value} onChange={(event) => setValue(event.target.value)} />
  );
};

API Reference

useDebouncy

function useDebouncy(
  fn: () => void | (() => void | undefined),
  wait?: number,
  deps?: any[],
): void;

Prop	Required	Default	Description
fn	✓		Debounce callback.
wait		0	Number of milliseconds to delay.
deps		[]	Array values that the debounce depends (like as useEffect).

Changelog

2.0.1 (2020-07-02)

Bug Fixes

• update information about bundle size (38017d2)