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

@logilab/react-faceted-search

v0.1.1

Published

Faceted search form for React

Downloads

39

Readme

react-faceted-search

|badge|

.. |badge| image:: https://jenkins.logilab.org/job/react-faceted-search/badge/icon :target: https://jenkins.logilab.org/job/react-faceted-search

This component relies on 2 elements:

  • a set of React components, to render the HTML markup;
  • a Filters object, that manages the filtering of the Entities.

The main component, FacetedSearchForm, takes several parameters:

  • schema, a definition of the data (see test/data/schema.js for an example);
  • config, a map of the entities and properties to display in the form;
  • filters, a list of default filters;
  • entities, a list of entities implementing the Entities interface.

To be called from the code rendering the form, one has to use the special ref property defined by React:

::

var config = {facets: new Map()}
config.facets.set('Pipe', ['pipe_usage', 'location_type', 'real_length'])
config.facets.set('SubStation', ['name'])
config.facets.set('Junction', ['name'])

render(
    <FacetedSearchForm
       schema={schema}
       config={config}
       entities={entities}
       ref={(ref) => this._form = ref}
    />,
    document.getElementById('entity-search-form')
)

The form will then be available using this._form.

Some methods are accessible through that ref:

  • addFilter(filter);
  • removeFilter(filter);
  • clearFilters();
  • getFilteredEntities().

The filter parameter passed to those methods is an object representing the filter. It can have one of the following shapes:

::

{
    entityType: 'Pipe',
    propertyName: 'name',
    value: 'my name'
}
{
    type: 'string_contains',
    entityType: 'Pipe',
    propertyName: 'identifier',
    value: 'P_'
}
{
    type: 'string_in_list',
    entityType: 'Pipe',
    propertyName: '__eid__',
    value: ['123', '345', '678']
}
{
    type: 'number_between',
    entityType: 'Pipe',
    propertyName: 'real_length',
    value: ['1', '10']
}