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 🙏

© 2025 – Pkg Stats / Ryan Hefner

react-cool-search

v1.1.5

Published

React hook for highly-performant search objects on a list.

Downloads

122

Readme

REACT-COOL-SEARCH

This is a React hook that provides a simples way to implement search/filter functionality on a list of objects based on their properties in React Components.

GitHub Workflow Status Coverage Status npm version npm downloads npm all downloads npm bundle size MIT License All Contributors GitHub Repo stars

Installation

This package is distributed via npm.

$ yarn add react-cool-search
# or
$ npm install --save react-cool-search

Usage

Common use case.

import useSearch from 'react-cool-search';

interface User {
  id: number;
  name: string;
  lastName: string;
}

const users: User[] = [
  { id: 1, name: 'Lorem', lastName: 'Ipsum' },
  { id: 2, name: 'Foo', lastName: 'Bar' },
  { id: 3, name: 'Feijão', lastName: 'Arroz' },
  { id: 4, name: 'John', lastName: 'Doe' },
];

const Users = () => {
  const { data, query, handleChange } = useSearch(users);

  return (
    <div>
      <input
        type="text"
        placeholder="Search users"
        value={query}
        onChange={handleChange}
      />
      <ul>
        {data.map(user => (
          <li key={user.id + user.name}>{user.name}</li>
        ))}
      </ul>
    </div>
  );
};

Definig fields to search.

import useSearch from 'react-cool-search';

interface User {
  id: number;
  name: string;
  lastName: string;
}

const users: User[] = [
  { id: 1, name: 'Lorem', lastName: 'Ipsum' },
  { id: 2, name: 'Foo', lastName: 'Bar' },
  { id: 3, name: 'Feijão', lastName: 'Arroz' },
  { id: 4, name: 'John', lastName: 'Doe' },
];

const Users = () => {
  const { data, query, handleChange } = useSearch(users, { fields: ['name'] });

  return (
    <div>
      <input
        type="text"
        placeholder="Search users only by name"
        value={query}
        onChange={handleChange}
      />
      <ul>
        {data.map(user => (
          <li key={user.id + user.name}>{user.name}</li>
        ))}
      </ul>
    </div>
  );
};

API

useSearch<T>

const obj = useSearch<T>(collection: T[], options?: Options);

react-cool-search provides a hook as default export; it takes two parameters:

| Key | Type | Default | Description | | ------------ | ------ | ------- | ---------------------------------------------- | | collection | Array | | An array of elements of type T. | | options | object | | Configuration object. See Options. |

Options

The options object contains the following properies:

| Key | Type | Default | Description | | -------------- | -------------- | ---------------------------- | ---------------------------------------------------------------------------------------- | | initialQuery | string | "" | The query used for the initial collection returned from useSearch | | debounce | number | 300 | Number of milliseconds to delay before triggering the function to filter the collection. | | fields | Array | Object.keys(collection[0]) | Properties that must be searched for each object in the collection. |

Return object

The hook returns an object with the following properies:

| Key | Type | Default | Description | | -------------- | -------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | data | Array | initialQuery ? filterCollection(collection) : collection | A filtered version of collection passed to useSearch. | | status | string | initialQuery ? 'OK' : 'IDLE' | Search status. It might be IDLE or OK or NOT_FOUND | | query | string | initialQuery | The current query | | handleChange | function | (event) => {} | An event handler for an HTML input element. This is to be passes to the search input element as its onChange prop. | | setQuery | function | (query) => {} | A function to programmatically set the query value. |

License

MIT © Arimário Jesus

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!