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 🙏

© 2024 – Pkg Stats / Ryan Hefner

autocomplete-searchbox

v1.0.0

Published

A reusable autocomplete search box component

Downloads

5

Readme

AutocompleteSearchBox Component

The AutocompleteSearchBox component is a reusable React component that provides a search box with autocomplete functionality. It can fetch suggestions from an API or a local JSON file based on the provided configuration.

Installation

To use the AutocompleteSearchBox component, install it in your React project:

npm install autocomplete-searchbox

Usage

Import the AutocompleteSearchBox component in your React component:

import React from 'react';
import AutocompleteSearchBox from 'autocomplete-searchbox';

Define a Data Fetching Functions

const fetchSuggestions = async (query, sourceType = 'api', jsonData = null) => {
  if (sourceType === 'api') {
    const response = await fetch(`https://api.example.com/search?q=${query}`);
    const data = await response.json();
    return data.results; // Adjust this according to your API response structure
  } else if (sourceType === 'json' && jsonData) {
    const filteredData = jsonData.filter(item => item.toLowerCase().includes(query.toLowerCase()));
    return filteredData;
  } else {
    throw new Error('Invalid source type or missing JSON data');
  }
};

Example 1: Fetch suggestions from a local JSON file

import jsonData from './data.json'; // Import the JSON file

const App = () => {
  return (
    <div>
      <h1>Autocomplete Search Box</h1>
      <AutocompleteSearchBox 
        suggestions={fetchSuggestions} 
        sourceType="json" 
        jsonData={jsonData}
        placeholder="Search for items..." 
        debounceTime={300}
        onSuggestionSelect={(suggestion) => console.log('Selected:', suggestion)}
      />
    </div>
  );
};

Example 2: Fetch suggestions from an API

const App = () => {
  return (
    <div>
      <h1>Autocomplete Search Box</h1>
      <AutocompleteSearchBox 
        fetchSuggestions={fetchSuggestions} 
        sourceType="api" 
        placeholder="Search for items..." 
        debounceTime={300}
        onSuggestionSelect={(suggestion) => console.log('Selected:', suggestion)}
      />
    </div>
  );
};

Props

| Prop | Type | Default | Description | | ------------------ | -------- | ----------- | ------------------------------------------------------ | | fetchSuggestions | function | required | Function to fetch suggestions based on the query. | | sourceType | string | 'api' | Type of data source: 'api' or 'json'. | | jsonData | array | null | Array of JSON data to use when 'sourceType' is 'json'. | | placeholder | string | 'Search...' | Placeholder text for the search input. | | debounceTime | number | 300 | Placeholder text for the search input. | | onSuggestionSelect | function | null | Function to handle the selection of a suggestion. |