SearchBox

SearchBox creates a search box UI component that is connected to one or more database fields. A SearchBox queries the appbase.io backend with query type suggestion to render different kind of suggestions, read more about the suggestion query type here.

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.
• Creating a product catalog search based on different categories.

Usage

Basic Usage

<template>
	<search-box componentId="SearchBoxSensor" :dataField="['group_venue', 'group_city']" />
</template>

Usage With All Props

<search-box
  componentId="SearchSensor"
  compoundClause="filter"
  :mode="tag"
  title="Search"
  defaultValue="Songwriting"
  placeholder="Search for cities or venues"
  highlightField="group_city"
  queryFormat="or"
  filterLabel="City"
  :autosuggest="true"
  :highlight="true"
  :showFilter="true"
  :dataField="[
    {
    	'field': 'group_venue',
    	'weight': 1
    },
    {
    	'field': 'group_city',
    	'weight': 3
    },
  ]"
  :defaultSuggestions="[
    { label: 'Songwriting', value: 'Songwriting' },
    { label: 'Musicians', value: 'Musicians' },
  ]"
  :fuzziness="0"
  :size="10"
  :debounce="100"
  :react="{
    and: ['CategoryFilter', 'SearchFilter']
  }"
  :URLParams="false"
  className="result-list-container"
  :size="3"
  :enablePopularSuggestions="true"
  :popularSuggestionsConfig="{ size: 3, minChars: 2, index: 'good-books-ds' }"
  :enableRecentSuggestions="true"
  :recentSuggestionsConfig="{
    size: 3,
    index: 'good-books-ds',
    minChars: 4,
  }"
  @on-data="
    (param) => {
    	// do something
    }
  "
  :showClear="true"
  @valueSelected="
    (value, cause) => {
    	// do something
    }
  "
  categoryField="authors.keyword"
  :defaultQuery="
    (value) => {
    	return {
          query: {
          	// ...
          },
          timeout: '1s',
    	};
    }
  "
  :customQuery="
    (value) => {
    	return {
          query: {
          	// ...
          },
          timeout: '1s',
    	};
    }
  "  
  :applyStopwords="true"
  :customStopwords="['be', 'the']"
  :enablePredictiveSuggestions="true"
  :endpoint="{
    url:'https://appbase-demo-ansible-abxiydt-arc.searchbase.io/recipes-demo/_reactivesearch.v3',
    headers: {
        // put relevant headers
    },
    method: 'POST'
  }"  
/>

Props

componentId

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

compoundClause

Configure whether the DSL query is generated with the compound clause of must or filter. If nothing is passed the default is to use must. Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn’t relevant (e.g. term, geo or range type of queries that act as filters on the data)

This property only has an effect when the search engine is either elasticsearch or opensearch.

Note: compoundClause is supported with v8.16.0 (server) as well as with serverless search.

endpoint

endpoint prop provides the ability to query a user-defined backend service for this component, overriding the data endpoint configured in the ReactiveBase component. Accepts the following properties:

• url String [Required] URL where the data cluster is hosted.
• headers Object [optional]
  set custom headers to be sent with each server request as key/value pairs.
• method String [optional]
  set method of the API request.
• body Object [optional]
  request body of the API request. When body isn't set and method is POST, the request body is set based on the component's configured props.

• Overrides the endpoint property defined in ReactiveBase.
• If required, use transformResponse prop to transform response in component-consumable format.

mode

SearchBox component offers two modes of usage, select & tag. When mode is set to tag SearchBox allows selecting multiple suggestions. Defaults to select.

<template>
  <search-box
    componentId="title"
    highlight="true"
    :dataField="['title', 'text']"
    :mode="tag"
  />
</template>

dataField

index field(s) to be connected to the component’s UI view. SearchBox accepts an Array in addition to string, which is useful for searching across multiple fields with or without field weights.
Field weights allow weighted search for the index fields. A higher number implies a higher relevance weight for the corresponding field in the search results.
You can define the dataField property as an array of objects of the DataField type to set the field weights.
The DataField type has the following shape:

type DataField = {
  field: string;
  weight: number;
};

database field(s) to be queried against. Accepts an Array in addition to String, useful for applying search across multiple fields. Check examples at here.

Note:

1. The dataField property as DataField object is only available for ReactiveSearch version >= v3.0.0 and Appbase version v7.47.0.

size

number of suggestions to show. Defaults to 10.

excludeFields

fields to be excluded in the suggestion's query when autoSuggest is true.

includeFields

fields to be included in the suggestion's query when autoSuggest is true.

enablePopularSuggestions

Defaults to false. When enabled, it can be useful to curate search suggestions based on actual search queries that your users are making. Read more about it over here.

popularSuggestionsConfig

Specify additional options for fetching popular suggestions. It can accept the following keys:

• size: number Maximum number of popular suggestions to return. Defaults to 5.
• minCount: number Return only popular suggestions that have been searched at least minCount times. There is no default minimum count-based restriction.
• minChars: number Return only popular suggestions that have minimum characters, as set in this property. There is no default minimum character-based restriction.
• showGlobal: Boolean Defaults to true. When set to false, returns popular suggestions only based on the current user's past searches.
• index: string Index(es) from which to return the popular suggestions from. Defaults to the entire cluster.

    <search-box
        :enablePopularSuggestions="true"
        :popularSuggestionsConfig="{
            size: 5,
            minCount: 5,
            minChars: 3,
            showGlobal: false,
            index: 'good-books-ds',  // further restrict the index to search on
        }"
    />

enableFAQSuggestions

Defaults to false. When set to true, shows frequent user queries which on click instantly shows the answer for the query. FAQs are set from the dashboard by creating a Searchbox. Hence they require a searchboxId to be passed.

enableFeaturedSuggestions

Defaults to false. When set to true, featured suggestions are returned as suggestions as per the featured suggestions config (either defaults, or as set through featuredSuggestionsConfig or via Featured Suggestions settings in the control plane). Read more about it over here.

Featured suggestions allow creating autocomplete experiences with user-defined suggestions. They're specified using the Featured Suggestions API, introduced in 8.1.0. This is a beta API and subject to change.

enableDocumentSuggestions

Defaults to false. When set to true, show user’s recently accessed documents as suggestions. Using this requires setting of recently accessed documents (doc link).

When setting this prop, configure renderItem to render the document.

searchboxId

When featured suggestions are enabled, set the value of the searchboxId to use for fetching them. This is configurable via ReactiveSearch dashboard and the following API endpoint.

FAQSuggestionsConfig

Specify additional options for fetching featured suggestions.

It can accept the following keys:

• sectionLabel: string Label of the division under which all FAQ suggestions are shown
• size: number maximum number of faq suggestions fetched per section.

    <search-box
        :enableFAQSuggestions="true"
        searchboxId="rs_docs"
        :FAQSuggestionsConfig="{
          size: 2,
          sectionLabel: '❓ FAQ Suggestions'
        }"
    />

featuredSuggestionsConfig

Specify additional options for fetching featured suggestions.

It can accept the following keys:

• maxSuggestionsPerSection: number maximum number of featured suggestions fetched per section.
• sectionsOrder: Array<String> accepts an array of section id(s). The order in which section id(s) are defined in the array describes the order in which the sections appear in the UI.

    <search-box
        :enable-featured-suggestions="true"
        searchbox-id="document-search"
        :featured-suggestions-config="{
            maxSuggestionsPerSection: 10,    
            sectionsOrder: ['document', 'pages', 'help'], 
        }"
    />

documentSuggestionsConfig

Specify additional options for fetching recent document suggestions.

It can accept the following keys:

• sectionLabel: string Label of the division under which all document suggestions are shown
• size: number maximum number of document suggestions to be fetched per section
• from: number offset of the document suggestions, this enables paginating to show more suggestions on a scroll behavior. This requires controled usage to modify
• maxChars: number maximum number of characters in the search input for which document suggestions get returned. If the input length exceeds this value, then document suggestions will not be returned. Defaults to 6

enablePredictiveSuggestions

Defaults to false. When set to true, it predicts the next relevant words from a field's value based on the search query typed by the user. When set to false (default), the entire field's value would be displayed. This may not be desirable for long-form fields (where average words per field value is greater than 4 and may not fit in a single line).

enableRecentSuggestions

Defaults to false. When set to true, recent searches are returned as suggestions as per the recent suggestions config (either defaults, or as set through recentSuggestionsConfig or via Recent Suggestions settings in the control plane). Appbase.io recommends defining a unique id(userId property) in reactivesearchAPIConfig prop for each user to personalize the recent searches.

Note: Please note that this feature only works when recordAnalytics is set to true in reactivesearchAPIConfig.

recentSuggestionsConfig

Specify additional options for fetching recent suggestions.

It can accept the following keys:

• size: number

Maximum number of recent suggestions to return. Defaults to 5.

• minHits: number

Return only recent searches that returned at least minHits results. There is no default minimum hits-based restriction.

• minChars: number

Return only recent suggestions that have minimum characters, as set in this property. There is no default minimum character-based restriction.

• index: string

Index(es) from which to return the recent suggestions from. Defaults to the entire cluster.

    <search-box
        :enableRecentSuggestions="true"
        :recentSuggestionsConfig="{
            size: 5,
            minHits: 5,
            minChars: 3,
            index: 'good-books-ds',  // further restrict the index to search on
        }"
    />

aggregationSize

To set the number of buckets to be returned by aggregations.

Note: This is a new feature and only available for appbase versions >= 7.41.0.

nestedField

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

set the title of the component to be shown in the UI.

defaultValue

preset the search query text in the search box.

Data type is Array when mode prop is set to tag.

value

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 change event.

Data type is Array when mode prop is set to tag.

fieldWeights

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

set placeholder text to be shown in the component's input field. Defaults to "Search".

autosuggest

set whether the autosuggest functionality should be enabled or disabled. Defaults to true. When set to false, it searches as user types, unless debounce is also set.

enableAI

enables the ability to ask questions with SearchBox and display AI generated answers from within SearchBox component itself. Defaults to false.

AIConfig

Specify additional options for configuring the LLM context + prompt for AI answer.

Accepts the following properties:

• systemPrompt String [optional] The system prompt to send as the first message to ChatGPT. Defaults to You are a helpful assistant.
• docTemplate String [optional] Template to use for building the message sent to ChatGPT for every hit of the response. The docTemplate string supports dynamic values using the special syntax ${}. These values are resolved while the ChatGPT request body is built. It supports keys that are present in the _source field in the response hits. As an example, source.title will resolve to _source.title. If values are not found, defaults to an empty string.
• queryTemplate String [optional] Template to use for building the message that is sent to ChatGPT as the final question. Defaults to Can you tell me about ${value} where value is the query.value. The querytemplate string supports a dynamic value of value which is the query.value of the query.
• topDocsForContext number [optional] Number of docs to use to build the context. Defaults to 3. This has an upper limit as the total number of hits returned.
• maxTokens number [optional] The maximum tokens that can be used for the output. Deafults to being dynamically calculated. Accepts a value between [1, 8000].
• temperatue number [optional] A control for randomness, a lower value implies a more deterministic output. Defaults to 1, valid values are between [0, 2].

AIUIConfig

Specify additional options for configruing AI screen.

Accepts the following properties:

• showFeedback Boolean [optional] Toggles displaying the feedback UI component to record AI session's feedback. Defaults to true.

  Use in conjunction with reactivesearchAPIConfig.recordAnalytics set to true in ReactiveBase.

• loaderMessage String [optional] Loading message to show when the AI Answer response is loading. The default value is: Computing an answer from the top documents.... User #AILoaderMessage slot-scope for custom html markup.

• showSourceDocuments Boolean [optional] Whether to show the documents from which the AIAnswer is generated or not. Defaults to true.

• renderSourceDocument Function [optional] Render a custom label by returning string or JSx. Default label is rendered as the resolved value of _id when showSourceDocument is set to true.

  Copy

    <search-box
    	className="result-list-container"
    	componentId="BookSensor"
    	:dataField="['original_title', 'original_title.search']"
    	:enableAI="true"
    	:AIUIConfig="{
    		showSourceDocuments: true,
    		renderSourceDocument: (obj) => '❤️ ' + obj.original_title,
    	}"
    />

• onSourceClick Function [optional] callback to handle side-effects when a source button is clicked. Accepts a sourceObj param associated with the source button clicked.

• askButton Boolean [optional] When set to true, the AI answer action and the corresponding display of AIAnswer would be triggered when user presses the Ask button. Defaults to false. You can provide styles with ask-button key for the innerClass prop.

• triggerOn string [optional] sets the trigger for fetching the AI answer. Defaults to manual, Accepts one of the following three:

  • manual - AI answer is shown when triggered using the askButton or clicking the first suggestion item(renderTriggerMessage).
  • question - AI answer is shown when the user searches for a question.

• renderTriggerMessage String | slot-scope [optional]
  custom markup to display as the first suggestion in the dropdown to trigger the AI answer. It should be used along with enableAI set to true.

strictSelection

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.

showIcon

whether to display a search or custom icon in the input box. Defaults to true.

iconPosition

sets the position of the search icon. Can be set to either left or right. Defaults to right.

icon

set a custom search icon instead of the default icon 🔍

showClear

show a clear text X icon. Defaults to true.

showFilter

show as filter when a value is selected in a global selected filters view. Defaults to true.

showVoiceSearch

show a voice icon in the searchbox to enable users to set voice input. Defaults to false.

showDistinctSuggestions

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:
<SearchBox dataField=['name', 'address'] .../>

// Search Query:
"wa"

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

Warn
Washington

Note: Check the above concept in action over here.

filterLabel

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.

clearIcon

set a custom icon for clearing text instead of the default cross.

debounce

set the milliseconds to wait before executing the query. Defaults to 0, i.e. no debounce.

highlight

whether highlighting should be enabled in the returned results.

highlightField

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

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 SearchBox component uses a customHighlight as given below,

<template>
	<search-box
		componentId="title"
		highlight="true"
		:dataField="['title', 'text']"
		:customHighlight="getCustomHighlight"
	/>
</template>
<script>
	export default {
		name: 'app',
		methods: {
			getCustomHighlight: props => ({
				highlight: {
					pre_tags: ['<mark>'],
					post_tags: ['</mark>'],
					fields: {
						text: {},
						title: {},
					},
					number_of_fragments: 0,
				},
			}),
		},
	};
</script>

focusShortcuts

A list of keyboard shortcuts that focus the search box. Accepts key names and key codes. Compatible with key combinations separated using '+'. Defaults to ['/'].

autoFocus

When set to true, search box is auto-focused on page load. Defaults to false.

expandSuggestionsContainer

When set to false the width of suggestions dropdown container is limited to the width of searchbox input field. Defaults to true.

 <search-box
      expandSuggestionsContainer={false}
      ...
  >
    <template #addonBefore>
      <img src="..." />
    </template>
    <template #addonAfter>
      <img src="..." />
    </template>
  </search-box>

queryFormat

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

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.

Note:

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

innerRef

The innerRef prop along with the ref prop can be used to access the reference of the input element that can be used to access/manipulate the native events or values for input element. For, an example the below snippet changes the type of the input element to search from the text.

<template>
	<search-box
		componentId="BookSensor"
		dataField="['original_title', 'original_title.search']"
		ref="search-box"
		innerRef="input"
	/>
</template>
<script>
	export default {
		name: 'app',
		mounted() {
			this.$refs['search-box'].$children[0].$refs['input'].type = 'search';
		},
	};
</script>

URLParams

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

You can render suggestions in a custom layout by using the render as a prop or a slot.

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 parsed suggestions obtained from the applied query.
• rawData object An object of raw response as-is from elasticsearch query.
• 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 the following control props from downshift which can be used to bind list items with click/mouse events.
  • isOpen boolean Whether the menu should be considered open or closed. Some aspects of the downshift component respond differently based on this value (for example, if isOpen is true when the user hits "Enter" on the input field, then the item at the highlightedIndex item is selected).
  • getItemProps function Returns the props you should apply to any menu item elements you render.
  • getItemEvents function Returns the events you should apply to any menu item elements you render.
  • highlightedIndex number The index that should be highlighted.
• AIData: Object A wrapper object to provide access to AI screen properties. Use in conjunction with enableAI set to true. It contains the following keys:
  • question: String The current asked question.
  • answer: String Answer returned by the AI.
  • documentIds: Array<String> The documents' ids used for curating the AI answer.
  • loading: Boolean Loading status for the AI response.
  • sources: Array<Object> The list of document objects corresponding to the documentIds, used for curating the AI answer.
  • showAIScreen: Boolean Boolean value to indicate when to show the AI screen.
  • isAILoading: Boolean Loading status for the AI response.
  • AIError: Object Error returned while fetching the AI response.

You can use SearchBox with render slot as shown:

<search-box
	class="result-list-container"
	categoryField="authors.raw"
	componentId="BookSensor"
	:dataField="['original_title', 'original_title.search']"
	:URLParams="true"
>
  <template #render="{
			error,
			loading,
			downshiftProps: { isOpen, highlightedIndex, getItemProps, getItemEvents },
			data: suggestions,
            AIData: {
                question,
                answer,
                documentIds,
                loading,
                sources,
                showAIScreen,
                isAILoading,
                AIError
            }
		}"
  >
    <div class="suggestions">
      <div v-if="loading">loading...</div>
        <ul v-if="isOpen">
          <template v-for="suggestion in suggestions">
            <li
              style="{ background-color: highlightedIndex ? 'grey' : 'transparent' }"
              v-bind="getItemProps({ item: suggestion })"
              v-on="getItemEvents({ item: suggestion })"
              :key="suggestion._id"
            >
              {{ suggestion.label }}
            </li>
          </template>
        </ul>
	  </div>
  </template>
</search-box>

Or you can also use render as prop.

<template>
	<search-box :render="render" />
</template>
<script>
	export default {
		name: 'app',
		methods: {
			render({
				error,
				loading,
				downshiftProps: { isOpen, highlightedIndex, getItemProps, getItemEvents },
				data: suggestions,
			}) {...},
		},
	};
</script>

renderNoSuggestion

can be used to render a message when there are no suggestions found.

renderError

can be used to render an error message in case of any error.

<template #renderError="error">
  <div>Something went wrong!<br />Error details<br />{{ error }}</div>
</template>

getMicInstance

You can pass a callback function to get the instance of SpeechRecognition object, which can be used to override the default configurations.

renderMic

can be 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

  <template #renderMic="{ handleClick, status }">
      <div v-if="status === `ACTIVE`">
          <img src="/active_mic.png" onClick={handleClick} />
      </div>
      <div v-if="status === `DENIED`">
          <img src="/denied_mic.png" onClick={handleClick} />
      </div>
      <div v-if="status === `STOPPED`">
          <img src="/mute_mic.png" onClick={handleClick} />
      </div>
      <div v-if="typeof status === `undefined`">
          <img src="/inactive_mic.png" onClick={handleClick} />
      </div>
  </template>

recentSearchesIcon

You can use a custom icon in place of the default icon for the recent search items that are shown when enableRecentSearches prop is set to true. You can also provide styles using the recent-search-icon key in the innerClass prop.

    <search-box
        ...
        :enableRecentSearches="true"
        :innerClass="{
            'recent-search-icon': '...',
        }"
    >
        <recent-icon #recentSearchesIcon />
    </search-box>

popularSearchesIcon

You can use a custom icon in place of the default icon for the popular searches that are shown when enablePopularSuggestions prop is set to true. You can also provide styles using the popular-search-icon key in the innerClass prop.

    <search-box
        ...
        :enablePopularSuggestions="true"
        :innerClass="{
            'popular-search-icon': '...'
        }"
    >
      <popular-icon #popularSearchesIcon />
    </search-box>

addonBefore

Type	Optional
slot-scope	Yes
The HTML markup displayed before (on the left side of) the searchbox input field. Users can use it to render additional actions/ markup, eg: a custom search icon hiding the default.

  <search-box
      ...
      :enablePopularSuggestions="true"
      :innerClass="{
        'popular-search-icon': '...'
      }"
  >
    <template #addonBefore>
        <img 
          src="https://img.icons8.com/cute-clipart/64/000000/search.png"
          height="30px"
        />
    </template>
  </search-box>

addonAfter

The HTML markup displayed before (on the right side of) the searchbox input field. Users can use it to render additional actions/ markup, eg: a custom search icon hiding the default.

  <search-box
      ...
      :enablePopularSuggestions="true"
      :innerClass="{
        'popular-search-icon': '...'
      }"
  >
    <template #addonAfter>
      <img 
        src="https://img.icons8.com/cute-clipart/64/000000/search.png"
        height="30px"
      />
    </template>
  </search-box>

distinctField

This prop returns only the distinct value documents for the specified field. It is equivalent to the DISTINCT clause in SQL. It internally uses the collapse feature of Elasticsearch. You can read more about it over here.

distinctFieldConfig

This prop allows specifying additional options to the distinctField prop. Using the allowed DSL, one can specify how to return K distinct values (default value of K=1), sort them by a specific order, or return a second level of distinct values. distinctFieldConfig object corresponds to the inner_hits key's DSL. You can read more about it over here.

<search-box
  ....
  distinctField="authors.keyword"
  :distinctFieldConfig="{
    inner_hits: {
      name: 'most_recent',
      size: 5,
      sort: [{ timestamp: 'asc' }],
    },
    max_concurrent_group_searches: 4,
  }"
/>

index

The index prop can be used to explicitly specify an index to query against for this component. It is suitable for use-cases where you want to fetch results from more than one index in a single ReactiveSearch API request. The default value for the index is set to the app prop defined in the ReactiveBase component.

renderItem

You can render each suggestion in a custom layout by using the renderItem prop.

    <search-box
        componentId="BookSensor"
        // ...
      >
        <template #renderItem="item">
          <div class="suggestions">
            👋 &nbsp; {{ item.label }}
          </div>
        </template>
    </search-box>

When using enableDocumentSuggestions prop, the search value on document selection will set based on the .textContent value of the markup of this section. For implementing a navigation behavior, define a onClick callback function.

applyStopwords

When set to true, it would not predict a suggestion which starts or ends with a stopword. You can find the list of stopwords used by Appbase at here.

customStopwords

It allows you to define a list of custom stopwords. You can also set it through Index settings in the control plane.

categoryField

Data field whose values are used to provide category specific suggestions.

enterButton

When set to true, the results would only be updated on press of the button. Defaults to false. You can also provide styles using the enter-button key in the innerClass prop.

<img src="https://i.imgur.com/8ZoA42b.png" style="margin:0 auto;display:block;"/>

 <search-box
    :enterButton="true"        
  >
  // ... other slots
 </search-box>

renderEnterButton

The custom HTML markup displayed for enterButton. Use in conjunction with enterButton prop set to true.

<search-box
      ...
      :enterButton="true"
>
    <template
        #renderEnterButton="onClick"
    >
      <div :style="{ height: '100%', display: 'flex', alignItems: 'stretch' }">
         <button
            :style="{ border: '1px solid #c3c3c3', cursor: 'pointer' }"
            v-on:click="onClick"
        >
            🔍 Search
        </button>
      </div>
    </template>
</search-box>

renderSelectedTags

to custom render tags when mode is set to tag. Provides It accepts an object with these properties:

• values: Array<String> array of selected values.
• handleClear: Function - (string) => void function to clear a tag value. It accepts the tag value(String) as a parameter.
• handleClearAll: Function - () => void function to clear all selected values.

  <search-box
      ...
      :mode="tag"
      :innerClass="{
         'selected-tag': '...'
      }"
  >
		<template #renderSelectedTags="{ values, handleClear, handleClearAll }">
			<button
				style="{ background-color: highlightedIndex ? 'grey' : 'transparent'color: 'green' }"
				v-for="tagValue in values"
				:key="tagValue"
				@click="() => handleClear(tagValue)"
			>
				{{ tagValue }}
			</button>
		</template>
  </search-box>

renderAIAnswer

to custom render tags when mode is set to tag. Provides It accepts an object with these properties:

• question: String The current asked question.
• answer: String Answer returned by the AI.
• documentIds: Array<String> The documents' ids used for curating the AI answer.
• loading: Boolean Loading status for the AI response.
• sources: Array<Object> The list of document objects corresponding to the documentIds, used for curating the AI answer.

  <search-box
      ...
      :mode="tag"
      :innerClass="{
         'selected-tag': '...'
      }"
  >
		<template #renderAIAnswer="{ question, answer, documentIds, loading, sources}">
			// render custom AI screen
		</template>
  </search-box>

AILoaderMessage

to custom render the loader message for AI screen

  <search-box
      ...
      :mode="tag"
      :innerClass="{
         'selected-tag': '...'
      }"
  >
		<template #AILoaderMessage>
			// render custom AI screen loader message
      <div> loading AI ... ⏰</div>
		</template>
  </search-box>

renderAskButton

The custom HTML markup displayed for enterButton. Use in conjunction with askButton prop under AIUIConfig prop set to true.

<search-box
      ...
      :AIUIConfig="{
        askButton: true
      }"
>
    <template
        #renderAskButton="onClick"
    >
      <div :style="{ height: '100%', display: 'flex', alignItems: 'stretch' }">
         <button
            :style="{ border: '1px solid #c3c3c3', cursor: 'pointer' }"
            v-on:click="onClick"
        >
            Ask ❓
        </button>
      </div>
    </template>
</search-box>

renderSourceDocument

The custom HTML markup displayed for sourceDocumentLabel. Use in conjunction with showSourceDocuments prop under AIUIConfig prop set to true.

<search-box
      ...
      :AIUIConfig="{
        showSourceDocuments: true
      }"
>
    <template #renderSourceDocument="obj">
    	<span :title="obj._id">🙌🏻 {{ obj._id }}</span>
    </template>
</search-box>

Demo

Styles

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

• title
• input
• list
• recent-search-icon
• popular-search-icon
• featured-search-icon
• section-label
• active-suggestion-item
• suggestion-item
• enter-button
• selected-tag
• ask-button
• ai-source-tag
• ai-feedback

Read more about it here.

Extending

SearchBox component can be extended to:

1. customize the look and feel with className,
2. update the underlying DB query with customQuery,
3. connect with external interfaces using beforeValueChange, value-change and query-change,
4. specify how search suggestions should be filtered using react prop.

<template>
	<search-box
		className="custom-class"
		:customQuery="getCustomQuery"
		:beforeValueChange="handleBeforeValueChange"
		:react="{
            and: ['pricingFilter', 'dateFilter'],
            or: ['searchFilter']
        }"
    @value-change="handleValueChange"
    @query-change="handleQueryChange"
  />
</template>
<script>
	export default {
		name: 'app',
		methods: {
			getCustomQuery: (value, props) => {
				return {
					query: {
						match: {
							data_field: 'this is a test',
						},
					},
				};
			},
			handleBeforeValueChange: value => {
				// called before the value is set
				// returns a promise
				return new Promise((resolve, reject) => {
					// update state or component props
					resolve();
					// or reject()
				});
			},
			handleValueChange: value => {
				console.log('current value: ', value);
				// set the state
				// use the value with other js code
			},
			handleQueryChange: (prevQuery, nextQuery) => {
				// use the query with other js code
				console.log('prevQuery', prevQuery);
				console.log('nextQuery', nextQuery);
			},
		},
	};
</script>

className

CSS class to be injected on the component container.

customQuery

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 SearchBox component as long as the component is a part of react dependency of at least one other component.

defaultQuery

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

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.

Note:

If you're using Reactivesearch version >= 1.1.0, 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.');
	}
};

react

specify dependent components to reactively update SearchBox'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` 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.

Events

change

is an event that 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 event is useful to control the value updates of search input.

<template>
    <search-box
        value="value"
        @change="handleChange"
    />
</template>

<script>
export default {
  name: 'app',
    data() {
        return {
            value: ""
        }
    },
    methods: {
        handleChange(value, triggerQuery, event) {
            this.value = value;
            // Trigger the search query to update the dependent components
            triggerQuery({
              isOpen: false // To close the suggestions dropdown; optional
            })
        }
    }
};
</script>

Note:

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. The triggerQuery method accepts an object with isOpen property (default to false) that can be used to control the opening state of the suggestion dropdown.

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

• value-change is an event which accepts component's current value as a parameter. It is called everytime the component's value changes. This event 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 list item is selected in a "Discounted Price" SingleList.

• value-selected is called when a search is performed either by pressing enter key or the input is blurred.

• on-data gets triggered when either of data, rawData, aggregationData, loading and error changes. You can use a callback function to listen for the changes. The function receives data, rawData, aggregationData, loading and error as a single parameter object.

    <search-box
        componentId="BookSensor"
        // ... other props ...
        @on-data="(param) => { // do something }"
    />

error

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.

The following events to the underlying input element:

• blur
• focus
• key-press
• key-down
• key-up

Note:

1. All these events accepts the triggerQuery as a second parameter which can be used to trigger the SearchBox query with the current selected value (useful to customize the search query execution).
2. There is a known issue with key-press when autosuggest is set to true. It is recommended to use key-down for the consistency.

Examples

SearchBox with default props

SearchBox with default props

SearchBox with FAQ suggestions

Searchbox Featured suggestions

Customize suggestions using innerClass

	<SearchBox
	    title="SearchBox"
	    dataField={['original_title', 'original_title.search']}
	    componentId="BookSensor"
	    innerClass={{
            'section-label': 'section-label',
	    	'active-suggestion-item': 'active-test-suggestion',
	    	'suggestion-item': 'test-suggestion',
	    }}
	    enableFeaturedSuggestions
      searchboxId="document_search"
    />

Inside your css file ->

.section-label {
	font-weight: 800;
	font-size: 14px;
	text-decoration: overline;
}

.active-test-suggestion {
	border-left: 6px solid #ffa000;
	background-color: #6629ea !important;
	border-radius: 4px;
	margin: 3px;
}

.test-suggestion {
	background-color: #f0e1e1 !important;
	border-radius: 4px;
	margin: 3px;
}

SearchBox with AI Answer

Combining Search with the power of AI makes for a high precision and high recall answer. The example shows how SearchBox component can be used to display an AI Answer.