use-debounced-search v1.0.8

use-debounced-search

A custom React hook for debounced search functionality.

Installation

npm install use-debounced-search

Usage

import React from "react";
import useDebouncedSearch from "use-debounced-search";

const SearchComponent = () => {
  const { search, searched, handleChange, clearSearched, clearSearch } =
    useDebouncedSearch(500);

  return (
    <div>
      <input
        type="text"
        value={search}
        onChange={handleChange}
        placeholder="Search"
      />
      <p>Search value: {search}</p>
      <p>Searched value: {searched}</p>
    </div>
  );
};

export default SearchComponent;

API

The useDebouncedSearch hook returns an object with the following properties:

• search: The current search value.
• handleChange: A function to handle the input change event.
• debouncedSearch: A function to trigger the debounced search.
• clearSearch: A function to clear the search value.
• clearSearched: A function to clear the searched value.

Parameters

• delay (optional): The debounce delay in milliseconds. Default is 300.

##License This project is licensed under the MIT License. See the LICENSE file for details.