appbaseio / Reactivesearch

Reactive Search

UI components library for Elasticsearch: Available for React and Vue

Read how to build an e-commerce search UI

a.) with React, or b.) with Vue

Check out Searchbox if you're building search UIs for other JS frameworks, React Native or Flutter.

Check out the ReactiveSearch marketplace at reactiveapps.io.

Web designer templates for sketch.

iOS and Android designer templates for sketch.

TOC

1. ReactiveSearch: Intro
2. Features
3. Component Playground
4. Live Examples
5. Comparison with Other Projects
6. Installation
7. Docs Manual
8. Contributing
9. Other Projects You Might Like

1. ReactiveSearch: Intro

ReactiveSearch is an Elasticsearch UI components library for React and React Native. 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:

1. Sensor components and
2. Actuator components.

Each sensor component is built for applying a specific filter on the data. For example:

• A SingleList sensor component applies an exact match filter based on the selected item.
• A RangeSlider component applies a numeric range query based on the values selected from the UI.
• A 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.

2. Features

Design

• The sensor / actuator design pattern allows creating complex UIs where any number of sensors can be chained together to reactively update an actuator (or even multiple actuators).
• The library handles the transformation of the UI interactions into database queries. You only need to include the components and associate each with a DB field.
• Built in live updates - Actuators can be set to update results even when the underlying data changes in the DB.
• Comes with scoped and styled components. Doesn't require any external CSS library import, comes with className and innerClass support.
• Is themable via ThemeProvider.

Ease of Use

• One step installation with npm i @appbaseio/reactivesearch,
• A UMD build that works directly in the browser. Installation steps here,
• Styled and scoped components that can be easily extended,
• See the reactivesearch starter app.

🆕 ReactiveSearch API: Secure your ElasticSearch Queries

Based on a popular request, we have implemented support for a declarative API based on ReactiveSearch. The API is called ReactiveSearch API. It moves the query DSL generation logic to a backend system (an appbase.io service) instead of exposing it directly on the client-side. By strictly enabling only ReactiveSearch API use, you can also prevent script injections.

The main advantages of using it over the ElasticSearch Query DSL are:

• Query generation happens on the server-side - addressing the primary security concern around query injection.
• Easy recording of analytics events for search and clicks. Read more
• Application of query rules and functions for search queries. Read more

Using ReactiveSearch API instead of ElasticSearch's query DSL is an opt-in feature. You need to set the enableAppbase prop as true in your ReactiveBase component. This assumes that you are using appbase.io for your backend.

We recommend checking out this KitchenSink App that demonstrates the use of the ReactiveSearch API for all the ReactiveSearch components.

⬆ Back to Top

3. Component Playground

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.

4. Live Demos

A set of live demos inspired by real world apps, built with ReactiveSearch.

Web

• demos/airbeds - An airbnb-like booking search experience.
• demos/technews - A full-text search app on the Hacker News dataset.
• demos/gitxplore - Explore all the popular Github repositories.
• demos/productsearch - Filtered feed of products based on a small Product Hunt dataset.
• demos/booksearch - An book search app based on a goodbooks dataset.
• demos/ecommerce - An e-commerce car store app.

You can check all of them on the examples section of website.

Mobile

• Booksearch on Play Store: A booksearch app showing a searchable collection of over 10k books built with ReactiveSearch. Also available as a snack.
• Gitxplore on Play Store: A Github repository explorer app to search over the 25k+ most popular github repos.
• ReactiveTodos on App Store: A shared collaborative to-do list app to showcase the capability of Reactivesearch.

⬆ Back to Top

5. Comparison with Other Projects

Here, we share how ReactiveSearch compares with other projects that have similar aims.

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.

⬆ Back to Top

6. Installation

Installing ReactiveSearch is just one command.

• If you're using reactivesearch for web

npm install @appbaseio/reactivesearch

You can check out the quickstart guide with React here.

• If you're using reactivesearch for mobile (native)

npm install @appbaseio/reactivesearch-native

You can check out the quickstart guide with React Native here.

7. Docs Manual

The official docs for the Web library are at docs.appbase.io/docs/reactivesearch/v3.

The components are divided into four sections:

• List based UI components are at reactivesearch/v3/list.
• Range based UI components are at reactivesearch/v3/range.
• Search UI components are at reactivesearch/v3/search.
• Result components are at reactivesearch/v3/result.

Docs for React Native version of the library are available at docs.appbase.io/docs/reactivesearch/native.

⬆ Back to Top

8. Contributing

Please check the contribution guide.

9. Other Projects You Might Like

• arc API Gateway for ElasticSearch (Out of the box Security, Rate Limit Features, Record Analytics and Request Logs).

• searchbox A lightweight and performance focused searchbox UI libraries to query and display results from your ElasticSearch app (aka index).

  • Vanilla JS - (~16kB Minified + Gzipped)
  • React - (~30kB Minified + Gzipped)
  • Vue - (~22kB Minified + Gzipped)

• 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.

• 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.

⬆ Back to Top