Image to be displayed

DataSearch creates a search box UI component that is connected to one or more database fields.

Example uses:

  • Searching for a rental listing by its name or description field.
  • Creating an e-commerce search box for finding products by their listing properties.


Basic Usage

<DataSearch componentId="SearchSensor" dataField={['group_venue', 'group_city']} />

Usage With All Props

	dataField={['group_venue', 'group_city']}
	fieldWeights={[1, 3]}
	placeholder="Search for cities or venues"
		{ label: 'Songwriting', value: 'Songwriting' },
		{ label: 'Musicians', value: 'Musicians' },
		and: ['CategoryFilter', 'SearchFilter'],
	filterLabel="Venue filter"


  • componentId String unique identifier of the component, can be referenced in other components' react prop.

  • dataField String or Array database field(s) to be queried against. Accepts an Array in addition to String, useful for applying search across multiple fields.

  • size Number [optional] number of suggestions to show. Defaults to 10.

  • aggregationField String [optional] One of the most important use-cases this enables is showing DISTINCT results (useful when you are dealing with sessions, events and logs type data). It utilizes composite aggregations which are newly introduced in ES v6 and offer vast performance benefits over a traditional terms aggregation. You can read more about it over here. You can access aggregationData using render prop as shown:

        render={({aggregationData}) => {...}}

    If you are using an app with elastic search version less than 6, then defining this prop will result in error and you need to handle it manually using renderError prop.

    It is possible to override this query by providing defaultQuery or customQuery.

  • nestedField String [optional] Set the path of the nested type under which the dataField is present. Only applicable only when the field(s) specified in the dataField is(are) present under a nested type mapping.

  • title String or JSX [optional] set the title of the component to be shown in the UI.

  • defaultValue string [optional] set the initial search query text on mount.

  • value string [optional] sets the current value of the component. It sets the search query text (on mount and on update). Use this prop in conjunction with the onChange prop.

  • enableSynonyms bool [optional] Defaults to true, can be used to disable/enable the synonyms behavior for the search query. Read more about it here


    This property only works with ReactiveSearch API i.e when enableAppbase is set to true in ReactiveBase component.

  • downShiftProps Object [optional] allow passing props directly to the underlying Downshift component. You can read more about Downshift props here.

  • fieldWeights Array [optional] set the search weight for the database fields, useful when dataField is an Array of more than one field. This prop accepts an array of numbers. A higher number implies a higher relevance weight for the corresponding field in the search results.

  • placeholder String [optional] set placeholder text to be shown in the component's input field. Defaults to "Search".

  • showIcon Boolean [optional] whether to display a search or custom icon in the input box. Defaults to true.

  • iconPosition String [optional] sets the position of the search icon. Can be set to either left or right. Defaults to right.

  • icon JSX [optional] set a custom search icon instead of the default 🔍

  • showClear Boolean [optional] show a clear text X icon. Defaults to false.

  • clearIcon JSX [optional] allows setting a custom icon for clearing text instead of the default cross.

  • autosuggest Boolean [optional] set whether the autosuggest functionality should be enabled or disabled. Defaults to true.

  • strictSelection Boolean [optional] defaults to false. When set to true the component will only set its value and fire the query if the value was selected from the suggestion. Otherwise the value will be cleared on selection. This is only relevant with autosuggest.

  • defaultSuggestions Array [optional] preset search suggestions to be shown on focus when the search box does not have any search query text set. Accepts an array of objects each having a label and value property. The label can contain either String or an HTML element.

  • debounce Number [optional] set the milliseconds to wait before executing the query. Defaults to 0, i.e. no debounce.

  • highlight Boolean [optional] whether highlighting should be enabled in the returned results.

  • highlightField String or Array [optional] when highlighting is enabled, this prop allows specifying the fields which should be returned with the matching highlights. When not specified, it defaults to applying highlights on the field(s) specified in the dataField prop.

  • customHighlight Function [optional] a function which returns the custom highlight settings. It receives the props and expects you to return an object with the highlight key. Check out the technews demo where the DataSearch component uses a customHighlight as given below,

    	dataField={['title', 'text']}
    	customHighlight={props => ({
    		highlight: {
    			pre_tags: ['<mark>'],
    			post_tags: ['</mark>'],
    			fields: {
    				text: {},
    				title: {},
    			number_of_fragments: 0,
  • queryFormat String [optional] Sets the query format, can be or or and. Defaults to or.

    • or returns all the results matching any of the search query text's parameters. For example, searching for "bat man" with or will return all the results matching either "bat" or "man".
    • On the other hand with and, only results matching both "bat" and "man" will be returned. It returns the results matching all of the search query text's parameters.
  • fuzziness String or Number [optional] Sets a maximum edit distance on the search parameters, can be 0, 1, 2 or "AUTO". Useful for showing the correct results for an incorrect search parameter by taking the fuzziness into account. For example, with a substitution of one character, fox can become box. Read more about it in the elastic search docs.


    This prop doesn't work when the value of queryFormat prop is set to and.

  • showFilter Boolean [optional] show as filter when a value is selected in a global selected filters view. Defaults to true.

  • showDistinctSuggestions Boolean [optional] Show 1 suggestion per document. If set to false multiple suggestions may show up for the same document as searched value might appear in multiple fields of the same document, this is true only if you have configured multiple fields in dataField prop. Defaults to true.

    Example if you have showDistinctSuggestions is set to false and have following configurations

    // Your document:
    	"name": "Warn",
    	"address": "Washington"
    // Component:
    <DataSearch dataField=['name', 'address'] .../>
    // Search Query:

    Then there will be 2 suggestions from the same document as we have the search term present in both the fields specified in dataField.


Note: Check the above concept in action over here.

  • showVoiceSearch Boolean [optional] show a voice icon in the searchbox to enable users to set voice input. Defaults to false.
  • searchOperators Boolean [optional] Defaults to false. If set to true than you can use special characters in the search query to enable an advanced search behavior.
    Read more about it here.
  • filterLabel String [optional] An optional label to display for the component in the global selected filters view. This is only applicable if showFilter is enabled. Default value used here is componentId.
  • URLParams Boolean [optional] enable creating a URL query string param based on the search query text value. This is useful for sharing URLs with the component state. Defaults to false.
  • render Function [optional] You can render suggestions in a custom layout by using the render prop.
    It accepts an object with these properties:

    • loading: boolean indicates that the query is still in progress.
    • error: object An object containing the error info.
    • data: array An array of suggestions obtained from combining promoted suggestions along with the hits .
    • rawData object An object of raw response as-is from elasticsearch query.
    • promotedData: array An array of promoted results obtained from the applied query. Read More.
    • resultStats: object An object with the following properties which can be helpful to render custom stats:

      • numberOfResults: number Total number of results found
      • time: number Time taken to find total results (in ms)
      • hidden: number Total number of hidden results found
      • promoted: number Total number of promoted results found
    • value: string current search input value i.e the search query being used to obtain suggestions.
    • downshiftProps: object provides all the control props from downshift which can be used to bind list items with click/mouse events. Read more about it here.
	render={({ loading, error, data, value, downshiftProps: { isOpen, getItemProps } }) => {
		if (loading) {
			return <div>Fetching Suggestions.</div>;
		if (error) {
			return <div>Something went wrong! Error details {JSON.stringify(error)}</div>;
		return isOpen && Boolean(value.length) ? (
				{data.slice(0, 5).map((suggestion, index) => (
					<div key={suggestion.value} {...getItemProps({ item: suggestion })}>
				{Boolean(value.length) && (
					<div {...getItemProps({ item: { label: value, value: value } })}>
						Show all results for "{value}"
		) : null;

Or you can also use render function as children

            }) => (
                // return UI to be rendered
  • renderError String or JSX or Function [optional] can we used to render an error message in case of any error.

    renderError={(error) => (
                Something went wrong!<br/>Error details<br/>{error}
  • renderNoSuggestion String or JSX or Function [optional] can we used to render a message when there is no suggestions found.

    renderNoSuggestion={() => (
                No suggestions found
  • getMicInstance Function [optional] You can pass a callback function to get the instance of SpeechRecognition object, which can be used to override the default configurations.

  • renderMic String or JSX or Function [optional] can we used to render the custom mic option.
    It accepts an object with the following properties:

    • handleClick: function needs to be called when the mic option is clicked.
    • status: string is a constant which can have one of these values:
      INACTIVE - mic is in inactive state i.e not listening
      STOPPED - mic has been stopped by the user
      ACTIVE - mic is listening
      DENIED - permission is not allowed

      renderMic = {({ handleClick, status }) => {
      			switch(status) {
      				case 'ACTIVE':
      					return <img src="/active_mic.png" onClick={handleClick} />
      				case 'DENIED':
      				case 'STOPPED':
      					return <img src="/mute_mic.png" onClick={handleClick} />
      					return <img src="/inactive_mic.png" onClick={handleClick} />
  • onChange function [optional] is a callback function which accepts component's current value as a parameter. It is called when you are using the value prop and the component's value changes. This prop is used to implement the controlled component behavior.

    	onChange={(value, triggerQuery, event) => {
    			() => triggerQuery(),


If you're using the controlled behavior than it's your responsibility to call the triggerQuery method to update the query i.e execute the search query and update the query results in connected components by react prop. It is not mandatory to call the triggerQuery in onChange you can also call it in other input handlers like onBlur or onKeyPress.

  • onSuggestions Function [optional] You can pass a callback function to listen for the changes in suggestions. The function receives suggestions list.
  • onError Function [optional] You can pass a callback function that gets triggered in case of an error and provides the error object which can be used for debugging or giving feedback to the user if needed.



DataSearch component supports an innerClass prop to provide styles to the sub-components of DataSearch. These are the supported keys:

  • title
  • input
  • list

Read more about it here.


DataSearch component can be extended to:

  1. customize the look and feel with className, style,
  2. update the underlying DB query with customQuery,
  3. connect with external interfaces using beforeValueChange, onValueChange, onValueSelected and onQueryChange,
  4. specify how search suggestions should be filtered using react prop,
  5. use your own function to render suggestions using parseSuggestion prop. It expects an object back for each suggestion having keys label and value. The query is run against the value key and label is used for rendering the suggestions. label can be either String or JSX. For example,
  parseSuggestion={(suggestion) => ({
    label: (
            {suggestion._source.original_title} by
            <span style={{ color: 'dodgerblue', marginLeft: 5 }}>
    value: suggestion._source.original_title,
    source: suggestion._source  // for onValueSelected to work with parseSuggestion
  • it's also possible to take control of rendering individual suggestions with parseSuggestion prop or the entire suggestions rendering using the render prop. Check the custom suggestions recipe for more info.

  • add the following synthetic events to the underlying input element:

    • onBlur
    • onFocus
    • onKeyPress
    • onKeyDown
    • onKeyUp
    • autoFocus


    1. All these events accepts the triggerQuery as a second parameter which can be used to trigger the DataSearch query with the current selected value (useful to customize the search query execution).
    2. There is a known issue with onKeyPress when autosuggest is set to true. It is recommended to use onKeyDown for the consistency.
  style={{"paddingBottom": "10px"}}
    function(value, props) {
      return {
        query: {
            match: {
                data_field: "this is a test"
    function(value) {
      // called before the value is set
      // returns a promise
      return new Promise((resolve, reject) => {
        // update state or component props
        // or reject()
    function(value) {
      console.log("current value: ", value)
      // set the state
      // use the value with other js code
    function(value, cause, source) {
      console.log("current value: ", value)
    function(prevQuery, nextQuery) {
      // use the query with other js code
      console.log('prevQuery', prevQuery);
      console.log('nextQuery', nextQuery);
  // specify how and which suggestions are filtered using `react` prop.
    "and": ["pricingFilter", "dateFilter"],
    "or": ["searchFilter"]
  • className String CSS class to be injected on the component container.

  • style Object CSS styles to be applied to the DataSearch component.

  • customQuery Function takes value and props as parameters and returns the data query to be applied to the component, as defined in Elasticsearch Query DSL. Note: customQuery is called on value changes in the DataSearch component as long as the component is a part of react dependency of at least one other component.

  • defaultQuery Function is a callback function that takes value and props as parameters and returns the data query to be applied to the source component, as defined in Elasticsearch Query DSL, which doesn't get leaked to other components. In simple words, defaultQuery prop allows you to modify the query to render the suggestions when autoSuggest is enabled. Read more about it here.

  • beforeValueChange Function is a callback function which accepts component's future value as a parameter and returns a promise. It is called everytime before a component's value changes. The promise, if and when resolved, triggers the execution of the component's query and if rejected, kills the query execution. This method can act as a gatekeeper for query execution, since it only executes the query after the provided promise has been resolved.


    If you're using Reactivesearch version >= 3.3.7, beforeValueChange can also be defined as a synchronous function. value is updated by default, unless you throw an Error to reject the update. For example:

    beforeValueChange = value => {
        // The update is accepted by default
    	if (value && value.toLowerCase().contains('Social')) {
    		// To reject the update, throw an error
    		throw Error('Search value should not contain social.');
  • onValueChange Function is a callback function which accepts component's current value as a parameter. It is called everytime the component's value changes. This prop is handy in cases where you want to generate a side-effect on value selection. For example: You want to show a pop-up modal with the valid discount coupon code when a user searches for a product in a DataSearch.

  • onValueSelected Function is called with the value selected via user interaction. It works only with autosuggest and is called whenever a suggestion is selected or a search is performed by pressing enter key. It also passes the cause of action and the source object if the cause of action was 'SUGGESTION_SELECT'. The possible causes are:

  • onQueryChange Function is a callback function which accepts component's prevQuery and nextQuery as parameters. It is called everytime the component's query changes. This prop is handy in cases where you want to generate a side-effect whenever the component's query would change.

  • react Object specify dependent components to reactively update DataSearch's suggestions.

    • key String one of and, or, not defines the combining clause.

      • and clause implies that the results will be filtered by matches from all of the associated component states.
      • or clause implies that the results will be filtered by matches from at least one of the associated component states.
      • not clause implies that the results will be filtered by an inverse match of the associated component states.
    • value String or Array or Object

      • String is used for specifying a single component by its componentId.
      • Array is used for specifying multiple components by their componentId.
      • Object is used for nesting other key clauses.


DataSearch with default props