appbaseio/reactivesearch

Reactive Search

UI components library for Elasticsearch, OpenSearch, Solr, MongoDB: 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 a UI components library for React and Vue, designed to work with ReactiveSearch cloud. It has over 20 UI components consisting of Lists, Ranges, Search UIs, Result displays, AI Answer, Charts, and a way to bring an existing UI component into the library.

A UI component can be used for filtering or searching on the index. 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 SearchBox component applies a suggestions and search query based on the search term typed by the user.

UI components can be used together (react prop allows configuring this on a per-component level) and render the matching results via a result display UI component.

ReactiveSearch supports the following built-in display components for displaying results (aka hits):

1. ReactiveList - ReactiveList supports list and card display formats as well as allows custom rendering at both item and component level,
2. ReactiveMap - ReactiveMap offers choice of Google Maps and OpenStreetMaps for map rendering,
3. AIAnswer - AIAnswer offers Retrieval Augmented Generation (RAG) via search engine and OpenAI models, and
4. ReactiveChart - Powered by Apache E-Charts, ReactiveChart offers 5 built-in chart types: pie, bar, histogram, line, scatter, and additional charts in the Apache E-Charts format. ReactiveChart is only supported for React at this time.

2. Features

Design

• The UI components's query generation and ability to react allows for creating complex UIs where a number of UI components can reactively update based on user interaction.
• The library handles the transformation of the UI interactions into search intent queries.
• Comes with scoped and styled components with className`` and innerClass` prop support.
• Is themable via ThemeProvider.

Ease of Use

• One step installation with npm i @appbaseio/reactivesearch,
• Styled and scoped components that can be easily extended,
• See the reactivesearch starter app.

🆕 ReactiveSearch API: Secure your Search Queries

Starting ReactiveSearch v4 (current major release), the library only sends the search intent, specification for this is here - ReactiveSearch API ref. Based on the choice of search engine you configure in ReactiveSearch cloud, the search query DSL is then generated by ReactiveSearch cloud. This approach is both more secure as well as allows transfering the search business logic on the server-side.

If you're using ReactiveSearch v3 (last major release), use of ReactiveSearch API over 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 stories 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/booksearch - An book search app based on a goodbooks dataset.
• BookSearch with Antd - A demo showing use of Ant design's theming and UI components with ReactiveSearch
• E-commerce Movie Search - A demo showing an e-commerce movie search UI
• Dashboard search and charts - A demo with user authentication: login, search and charts UIs.

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

⬆ 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 React

npm install @appbaseio/reactivesearch

You can check out the quickstart guide with React here.

• If you're using reactivesearch for Vue

npm install @appbaseio/reactivesearch-vue

You can check out the quickstart guide with Vue here.

7. Docs Manual

The official docs for the React library are at docs.reactivesearch.io/docs/reactivesearch/react.

The components are divided into four sections:

• List based UI components are at reactivesearch/react/list.
• Range based UI components are at reactivesearch/react/range.
• Search UI components are at reactivesearch/react/search.
• Result components are at reactivesearch/react/result.
• Map components are at reactivesearch/react/map.
• Chart components are at reactivesearch/react/chart.

Docs for Vue version of the library are available at docs.reactivesearch.io/docs/reactivesearch/vue.

⬆ Back to Top

8. Contributing

Please check the contribution guide.

9. Other Projects You Might Like

• ReactiveSearch API API Gateway for ElasticSearch, OpenSearch, Solr, MongoDB, OpenAI (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 with ReactiveSearch Cloud.

  • Vanilla JS
  • Flutter

• dejavu Elasticsearch / OpenSearch data viewer and editor

• appbase-js For when you need to index data in addition to UI components

⬆ Back to Top