react-searchbox provides declarative props to query Elasticsearch, and bind UI components with different types of search queries. As the name suggests, it provides a default UI component for searchbox.

Installation

To install react-searchbox, you can use npm or yarn to get set as follows:

Using npm

npm install @appbaseio/react-searchbox

Using yarn

yarn add @appbaseio/react-searchbox

Basic usage

You can watch this video for an intro to React Searchbox and follow along to build out the example search UI.

A simple example

The following example renders an autosuggestion search bar(search-component) with one custom component(result-component) to render the results. The result-component watches the search-component for input changes and updates its UI when the user selects a suggestion.

import React from 'react';

import { SearchBox, SearchBase, SearchComponent } from '@appbaseio/react-searchbox';

export default () => (
    <SearchBase
        index="good-books-ds"
        credentials="a03a1cb71321:75b6603d-9456-4a5a-af6b-a487b309eb61"
        url="https://arc-cluster-appbase-demo-6pjy6z.searchbase.io"
    >
        <div>
            <SearchBox
                id="search-component"
                dataField={[
                    {
                        field: 'original_title',
                        weight: 1,
                    },
                    {
                        field: 'original_title.search',
                        weight: 3,
                    },
                ]}
                title="Search"
                placeholder="Search for Books"
                defaultSuggestions={[
                    {
                        label: 'Songwriting',
                        value: 'Songwriting',
                    },
                    {
                        label: 'Musicians',
                        value: 'Musicians',
                    },
                ]}
            />
            <SearchComponent
                id="result-component"
                highlight
                dataField="original_title"
                react={{
                    and: ['search-component'],
                }}
            >
                {({ results, loading }) => {
                    return (
                        <div>
                            {loading ? (
                                <div>Loading Results ...</div>
                            ) : (
                                <div>
                                    {!results.data.length ? (
                                        <div>No results found</div>
                                    ) : (
                                        <p>
                                            {results.numberOfResults} results found in{' '}
                                            {results.time}
                                            ms
                                        </p>
                                    )}
                                    {results.data.map(item => (
                                        <div key={item._id}>
                                            <img
                                                src={item.image}
                                                alt="Book Cover"
                                                className="book-image"
                                            />
                                            <div>
                                                <div
                                                    dangerouslySetInnerHTML={{
                                                        __html: item.original_title,
                                                    }}
                                                />
                                                <span>
                                                    Pub {item.original_publication_year}
                                                </span>
                                            </div>
                                        </div>
                                    ))}
                                </div>
                            )}
                        </div>
                    );
                }}
            </SearchComponent>
        </div>
    </SearchBase>
);

You can play with this example over here.

An example with a facet

import React from "react";

import {
  SearchBox,
  SearchBase,
  SearchComponent
} from "@appbaseio/react-searchbox";

export default () => (
  <SearchBase
    index="good-books-ds"
    credentials="a03a1cb71321:75b6603d-9456-4a5a-af6b-a487b309eb61"
    url="https://arc-cluster-appbase-demo-6pjy6z.searchbase.io"
  >
    <div>
      <SearchBox
        id="search-component"
        dataField={[
          {
            field: "original_title",
            weight: 1
          },
          {
            field: "original_title.search",
            weight: 3
          }
        ]}
        title="Search"
        placeholder="Search for Books"
        defaultSuggestions={[
          {
            label: "Songwriting",
            value: "Songwriting"
          },
          {
            label: "Musicians",
            value: "Musicians"
          }
        ]}
      />
      <SearchComponent
        id="author-filter"
        type="term"
        dataField="authors.keyword"
        subscribeTo={["aggregationData", "requestStatus", "value"]}
        URLParams
        // To initialize with default value
        value={[]}
        render={({ aggregationData, loading, value, setValue }) => {
          return (
            <div>
              {loading ? (
                <div>Loading Filters ...</div>
              ) : (
                aggregationData.data.map((item) => (
                  <div key={item._key}>
                    <input
                      type="checkbox"
                      checked={value ? value.includes(item._key) : false}
                      value={item._key}
                      onChange={(e) => {
                        const values = value || [];
                        if (values && values.includes(e.target.value)) {
                          values.splice(values.indexOf(e.target.value), 1);
                        } else {
                          values.push(e.target.value);
                        }
                        // Set filter value and trigger custom query
                        setValue(values, {
                          triggerDefaultQuery: false,
                          triggerCustomQuery: true,
                          stateChanges: true
                        });
                      }}
                    />
                    <label htmlFor={item._key}>
                      {item._key} ({item._doc_count})
                    </label>
                  </div>
                ))
              )}
            </div>
          );
        }}
      />
      <SearchComponent
        id="result-component"
        highlight
        dataField="original_title"
        react={{
          and: ["search-component", "author-filter"]
        }}
      >
        {({ results, loading }) => {
          return (
            <div>
              {loading ? (
                <div>Loading Results ...</div>
              ) : (
                <div>
                  {!results.data.length ? (
                    <div>No results found</div>
                  ) : (
                    <p>
                      {results.numberOfResults} results found in {results.time}
                      ms
                    </p>
                  )}
                  {results.data.map((item) => (
                    <div key={item._id}>
                      <img
                        src={item.image}
                        alt="Book Cover"
                        className="book-image"
                      />
                      <div>
                        <div
                          dangerouslySetInnerHTML={{
                            __html: item.original_title
                          }}
                        />
                        <span>Pub {item.original_publication_year}</span>
                      </div>
                    </div>
                  ))}
                </div>
              )}
            </div>
          );
        }}
      </SearchComponent>
    </div>
  </SearchBase>
);

More Examples

Basic Usage

This example demonstrates the usage of some of the props available with react-searchbox. Please go over here to check it out.

Controlled Usage

In this example we can see the usage of search-box component in a controlled way using the value and onChange props and also how to use the transformRequest prop to get in more context from an extrenal API. Please go over here to check it out.

Advanced Usage

In this example, we have shown usage of the react-table library to display the search results in a tabular format. You can similarly integrate any kind of UI component - be it grid, charts, lists, sliders with the help of SearchComponent. Please go over here to check it out.

DistinctField Prop Usage

In this example, we have shown how to usage distinctField and distinctFieldConfig props to display distinct value documents based on the specified field. Please go over here to check it out.

EnablePredictiveSuggestions Prop Usage

In this example, we can see the usage of enablePredictiveSuggestions prop to prdict next relevant word in a serach query. Please go over here to check it out.

Index Prop Usage

In this example, we can see the usage of the index prop in the author-search-component to explicitly specify an index to query against for the component. Please go over here to check it out.

TransformRequest Prop Usage

In this example, we show the usage of the transformRequest prop, which gives us the request object whenever a query gets triggered from the search-box component. It allows us to either modify the request being sent or create a side-effect based on this request. Please go over here to check it out.

You can check out the docs for API Reference over here.