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

react-addsearch-ui

v0.1.2

Published

AddSearch UI for React

Downloads

75

Readme

React AddSearch UI

Implemements AddSearch's search-ui package as a ReactJS library exposing one single Component for Integration.

Setup

1. Add react-addsearch-ui to your dependencies:

npm i react-addsearch-ui
// pnpm i react-addsearch-ui
// yarn add react-addsearch-ui

2. Import and configure AddSearchUiIntegration component

import { AddSearchUiIntegration } from 'react-addsearch-ui';
import 'react-addsearch-ui/dist/style.css';

export default function App() {
    return (
        <div className="flex flex-col w-full h-full gap-6 p-6 items-center">
            <h1>My React AddSearch UI Integration Example</h1>
            <AddSearchUiIntegration publicSiteKey="YOUR_PUBLIC_SITEKEY(as ENV VAR ideally)" />
        </div>
    );
}
  • publicSiteKey can be found in your dashboard

3. Brand your Search UI

Brand Color:

<AddSearchUiIntegration publicSiteKey="YOUR_PUBLIC_SITEKEY" primaryColor="#004225" />

Custom Font:

Load font, e.g. by adding to your document head, e.g.:

<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
    href="https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap"
    rel="stylesheet"
/>

then use the customFont property on AddSearchUiIntegration:

<AddSearchUiIntegration
    publicSiteKey="YOUR_PUBLIC_SITEKEY"
    primaryColor="#004225"
    customFont="Poppins"
/>

4. Configure the UI

<AddSearchUiIntegration
    publicSiteKey="YOUR_PUBLIC_SITEKEY"
    primaryColor="#004225" // default AddSearch primary color
    customFont="Poppins" // no default
    searchFieldHeaderText="Search" // no default
    searchButtonText="Apply" // no default
    hasSearchInputFieldIcon={false} // default true
    hasSearchInputAutofocus={false} // default true
    searchInputPlaceholderText="What are you looking for?" // default "keyword"
    hasSearchAsYouType={true} // default false
    minLengthToShowSearchAsYouTypeResults={1} // default 3
    hasAutocomplete={true} // default true
    loadMoreResults={'button'} // default 'pagination'
    hasLoadMore={true} // default true
    sortByOptions={sortByOptions} // default []
    filters={[
        {
            labelText: 'Categories',
            type: 'checkbox-group',
            options: {
                pricing: {
                    label: 'Pricing',
                    filter: { category: '1xpricing' }
                },
                partners: {
                    label: 'Partners',
                    filter: { category: '1xpartners' }
                },
                customers: {
                    label: 'Customers',
                    filter: { category: '1xcustomers' }
                }
            }
        },
        {
            labelText: 'Documents',
            type: 'tags',
            options: {
                nofilter: {
                    label: 'All results'
                },
                blog: {
                    label: 'Blog',
                    filter: { category: '1xblog' }
                },
                docs: {
                    label: 'Documentation',
                    filter: { category: '1xdocs' }
                }
            }
        }
    ]}
    hasActiveFilters={true} // default true
/>
  • minLengthToShowSearchAsYouTypeResults affects both hasAutocomplete and hasSearchAsYouType
  • loadMoreResults defines what UI option to use for loading more results
  • sortByOptions and filtersOptions for configuration details visit SortBy Documentation and Filters Documentation respectively
  • filterTypes
  • filters can handle 1 'tabs' filter and 1 'select-list' filter and multiple filters of the other types (all supported types are 'tabs' | 'checkbox-group' | 'radio-group' | 'tags' | 'select-list')
  • hasActiveFiltersis disabled when using Tab Filters