Name: reactivesearch
Owner: appbase.io
Description: A React components library for building awesome :mag: search UIs
Created: 2017-02-15 15:21:24.0
Updated: 2018-01-19 18:55:42.0
Pushed: 2018-01-18 15:59:42.0
Homepage: https://opensource.appbase.io/reactivesearch
Size: 65427
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
React UI components for Elasticsearch.
v2 of reactivesearch
is here ?. Go read how to build an e-commerce search UI on codeburst.
npm install @appbaseio/reactivesearch
Get our designer templates for sketch.
ReactiveSearch is a React UI components library for Elasticsearch. It has 25+ components consisting of Lists, Ranges, Search UIs, Result displays and a way to bring any existing UI component into the library.
The library is conceptually divided into two parts:
Each sensor component is built for applying a specific filter on the data. For example:
SingleList
sensor component applies an exact match filter based on the selected item.RangeSlider
component applies a numeric range query based on the values selected from the UI.DataSearch
component applies a suggestions and search query based on the search term typed by the user.Sensor components can be configured to create a combined query context and render the matching results via an actuator component.
ReactiveSearch primarily comes with two actuators: ResultCard
and ResultList
. ResultCard displays the results in a card interface whereas ResultList displays them in a list. Both provide built-in support for pagination and infinite scroll views. Besides these, the library also provides low level actuators (ReactiveComponent and ReactiveList) to render in a more customized fashion.
ThemeProvider
.Try the live component playground at playground. Look out for the knobs section in the playground part of the stories to tweak each prop and see the effects.
A set of live demos inspired by real world apps, built with ReactiveSearch.
You can check all of them on the examples section of website.
Here, we share how ReactiveSearch
compares with other projects that have similar aims.
| # | ReactiveSearch | SearchKit | InstantSearch | | ——: | :——: | :——: | :——: | | Backend | Any Elasticsearch index hosted on any Elasticsearch cluster. | Any Elasticsearch index hosted on any Elasticsearch cluster. | Custom-built for Algolia, a proprietary search engine. | | Development | Actively developed and maintained. | Active issue responses, some development and maintenance. | Actively developed and maintained. | | Onboarding Experience | Starter apps, Live interactive tutorial, getting started guide, component playground, every component has a live working demo with codesandbox. | Getting started tutorial, no live component demos, sparse reference spec for many components. | Starter apps, getting started guide, component playground. | | Styling Support | Styled and scoped components. No external CSS import required. Rich theming supported as React props. | CSS based styles with BEM, not scoped to components. Theming supported with SCSS. | CSS based styles, requires external style import. Theming supported by manipulating CSS. | | Types of Components | Lists, Ranges, Search, Dates, Maps, Result Displays. Can use your own UI components. (Maps need an upgrade) | Lists, Ranges, Search, Result. Can't use your own UI components. (Only one component for Search and Result, resulting in more code to be written for customizability) | Lists, Range, Search, Result. Can use your own UI components. | | Supported Distribution Platforms* | React for Web, React Native for mobile in alpha and actively developed. | React for Web. | React, Vue, Angular, vanilla JS for Web, React Native for mobile but latter has no UI components. |
We welcome contributions to this section. If you are building a project or you know of another project that is in the similar space, let us know and we will update the comparisons.
Installing ReactiveSearch is just one command.
install @appbaseio/reactivesearch
You can also read about it here.
Follow the getting started guide to build a Hello Search! app from the official docs here.
The official docs for the library are at https://opensource.appbase.io/reactive-manual.
The components are divided into four sections:
Please check the contribution guide.
ReactiveSearch Dashboard All your Reactive Search related apps (created via interactive tutorial, shared by others, etc.) can be accessed from here.
ReactiveMaps is a similar project to Reactive Search that allows building realtime maps easily.
appbase-js While building search UIs is dandy with Reactive Search, you might also need to add some input forms. appbase-js comes in handy there.
dejavu allows viewing raw data within an appbase.io (or Elasticsearch) app. Soon to be released feature: An ability to import custom data from CSV and JSON files, along with a guided walkthrough on applying data mappings.
mirage ReactiveSearch components can be extended using custom Elasticsearch queries. For those new to Elasticsearch, Mirage provides an intuitive GUI for composing queries.