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

@dotdev/reactive-searchspring

v1.9.1

Published

### Overview

Downloads

50

Readme

Reactive SearchSpring

Overview

SearchSpring is a service which provides a straight-forward Search API to filter large amounts of data (similar to Elasticsearch), responses from the Search API include matching items, metadata about the current query, which filters are applied, which filters can be applied and more.

The Reactive SearchSpring library provides a collection of utility components which can be used to mutate a Search Request. The utility components are entirely generic and expect styling and positioning to be implemented by the caller, the props which are passed to the components include methods for mutating the Search Request and metadata from SearchSpring.

Examples

  • https://reactive-searchspring.netlify.app/instant-search
  • https://reactive-searchspring.netlify.app/search
  • https://reactive-searchspring.netlify.app/collection
  • https://reactive-searchspring.netlify.app/prev-next
  • https://reactive-searchspring.netlify.app/infinite
  • https://reactive-searchspring.netlify.app/load-more

Install

This package is private and requires access to the @dotdev organization to install.

yarn add @dotdev/reactive-searchspring

Usage

At the heart of @dotdev/reactive-searchspring is the [[SearchSpring]] class, each instance contains a scoped set of filters and results and is implemented with the React Context API.

You can create an instance with the SearchSpring.Provider component and nested within that you can build an interface for mutating and displaying the Search Request with the other utility components such as adding a search input filter with the SearchSpring.Search component and a list of results with the SearchSpring.Results component.

import { render } from "react-dom";
import { SearchSpring } from "@dotdev/searchspring";

const Example = () => (
  <SearchSpring.Provider
    searchspringOptions={...}
  >
    <SearchSpring.Search
      render={({ setSearch }) => (
        <input type="search" onChange={(event) => setSearch(event.target.value)} />
      )}
    />
    <SearchSpring.Results
      pagination={{
        page: 1,
        limit: 32,
      }}
      render={{
        result: ({ result }) => <div><span>{result.title}</span> - <strong>{result.price}</strong></div>,
        loading: () => <div><span>Loading...</span></div>,
        empty: () => <div><span>No Results.</span></div>,
      }}
    />
  </SearchSpring.Provider>
);

render(
  <Example />,
  document.getElementById("root"),
);

See the /examples folder for complete example implementations.

Development

Transpile

The @dotdev/reactive-searchspring package is transpiled with the Typescript Compiler and not minified or optimized beyond that, no additional tooling is required to transpile.

Scripts

Scripts are intended to be executed with yarn.

yarn run <script>

package

Transpile source into Javascript, optional --watch flag to re-transpile on source file change.

lint

Lint the source with tslint.

docs

Generate docs with typedoc.