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

rg-search

v0.0.7

Published

Singlepage search library

Downloads

6

Readme

Build Status Test Coverage Code Climate Issue Count Dependencies

NPM

Installation

npm install rg-search

Usage

var travelSearch = new RGsearch(name, options);

rg-search does not care about what kind of elements or methods you use to apply filters to the search. The only thing it cares about is reading the filter keys and values from the elemens containing these. rg-search will work the these data attributes

  • data-rgsearch-filter-keys
  • data-rgsearch-filter-values

Your initial markup should contain the data-attributes with the initial values eg:

<ul class="rgsearch-filter" data-rgsearch-filter-keys="key1, key2" data-rgsearch-filter-values="value1, value2">
    <li>
        <input type="checkbox" onclick="travelSearch.applyFilters(['key1', 'key2'], ['value2', 'value1'])"> <span>Value 1</span>
        <input type="checkbox" onclick="travelSearch.applyFilters(['key1', 'key2'], ['value1', 'value2'])"> <span>Value 2</span>
    </li>
</ul>

This elements will be selected by the classname rgsearch-filer. So you MUST apply this classname to whatever element also containing the filter data attributes.

To change the filters so that the search will update, you just call the applyFilters method, wil two arrays as parameters. The first array should be the filter-keys to update, and the last array should be the values to update to. The two array MUST be in the same order to work properly. You dont need to call the applyFilter method from onclick in the markup. It can just as well be used from inside any javascript you use to control your search-app. eg:

element.on("click", function() {
    travelSearch.applyFilters(["key1", "key2"], ["value1", "value2"]);
});