AddSearch Search UI Library

Use Search UI library to create fast, mobile-friendy, and cross-browser compatible search solutions quickly and effortlessly.

Open the demo

Quick example

<!-- Libraries -->
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/addsearch-js-client.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/addsearch-search-ui.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/addsearch-search-ui.min.css" />

<!-- Containers for UI components-->
<div id="searchfield-container"></div>
<div id="results-container"></div>
<div id="pagination-container"></div>

<script>
  // AddSearch JS client instance
  var client = new AddSearchClient('YOUR PUBLIC SITEKEY');

  // Search UI instance
  var searchui = new AddSearchUI(client);

  // UI components
  searchui.searchField({
    containerId: 'searchfield-container',
    placeholder: 'Keyword..',
    button: 'Search'
  });

  searchui.searchResults({
    containerId: 'results-container'
  });
  
  searchui.pagination({
    containerId: 'pagination-container'
  });
  
  // Start after all components are added
  searchui.start();
</script>

Examples

Basic example

• Try it out
• View source code

Advanced example with many components

• Try it out
• View source code

See more examples

• All examples
• View source code

Search UI instance and configuration

To create a Search UI instance, call the constructor new AddSearchUI(client, conf) with the mandatory AddSearchClient (v0.3.0 or newer) parameter and an optional configuration parameter:

var client = new AddSearchClient('YOUR PUBLIC SITEKEY');

var conf = {
  debug: true
};

var searchui = new AddSearchUI(client, conf);

The configuration object can contain following values:

Key	Possible values	Default value	Description
debug	boolean	false	Log events to console and enable Redux DevTools
analyticsCallback	function	n/a	A function to call when an analytics event occurs. Read more
collectAnalytics	boolean	true	Control if analytics events are collected at all
matchAllQuery	boolean	false	Execute "match all" query when the Search UI is started
onFilterChange	function	n/a	Function to call when active filters are changed (for conditional visibility)
searchResultsPageUrl	String	null	Redirect the user to a separate search results page, instead of showing search results on the current page
searchParameter	String	"search"	Name of the search parameter which is added to the URL, by default the library adds "?search="

After all UI components have been added to the SearchUI object, the start function must be called:

  searchui.start();

Components

Search field

The search field. Can include a button to execute the search.

  searchui.searchField({
    containerId: 'searchfield',
    placeholder: 'Keyword..',
    button: 'Search'
  });

Settings that can be passed to the searchField function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for the search bar
autofocus	boolean	true	Focus the input field automatically when the page is loaded
button	String	n/a	Add a button to execute the search. The value of this field is the Button's label text
placeholder	String	n/a	Search field's placeholder text
searchAsYouType	boolean	false	Execute search after every keystroke
icon	boolean	true	Show search icon
ignoreAutocomplete	boolean	false	Don't show the autocomplete component if something is typed to this field (in case you have multiple fields)
ignoreSearchResultsPageUrl	boolean	false	Don't redirect the user to a search results page from this field (in case you have multiple fields)
template	String	Default template	Override the default template with a custom Handlebars template

Autocomplete

Show suggested keyword, search results, or both under the search field. The default autocomplete template supports search suggestions that must be enabled from the AddSearch Dashboard before using the feature. Create your own template if you want to to show search results or more advanced views.

  searchui.autocomplete({
    containerId: 'autocomplete',
    sources: [
      {
        type: AddSearchUI.AUTOCOMPLETE_TYPE.SUGGESTIONS
      }
    ]
  });

Settings that can be passed to the autocomplete function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for the autocomplete dropdown
categoryAliases	Object	n/a	A map of category aliases used by the categorySelectionFunction
categorySelectionFunction	Function	defaultCategorySelectionFunction	A function to select and format the category information on the bottom of each search result
hideAutomatically	boolean	true	Hide the autocomplete dropdown when the search field is blurred
onShow	function	n/a	A function to call when the autocomplete is shown. Called as the container as parameter
template	String	Default template	Override the default template with a custom Handlebars template
infiniteScrollElement	object	n/a	A scrollable container with overflow: auto; around the autocomplete box (for AddSearchUI.AUTOCOMPLETE_TYPE.SEARCH)
sources	Array	n/a	Array of data sources

The sources array can contain objects with the following fields:

Key	Possible values	Default value	Description
type	AddSearchUI.AUTOCOMPLETE_TYPE.SUGGESTIONS, AddSearchUI.AUTOCOMPLETE_TYPE.SEARCH	n/a	Fetch search suggestions or search results
client	AddSearch JS Client instance	Client passed to the AddSearchUI constructor	Use a custom client to use specific filters or different search index
jsonKey	String	n/a	If the type is AddSearchUI.AUTOCOMPLETE_TYPE.SEARCH, the Handlebars template can access the results from the JSON object searchResults.<jsonKey>

Search results

Actual search results.

  searchui.searchResults({
    containerId: 'searchresults'
  });

Settings that can be passed to the searchResults function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for search results
categoryAliases	Object	n/a	A map of category aliases used by the categorySelectionFunction
categorySelectionFunction	Function	defaultCategorySelectionFunction	A function to select and format the category information on the bottom of each search result
template	String	Default template	Override the default template with a custom Handlebars template for search results
template_resultcount	String	Default template	Override the default template with a custom Handlebars template for "Number of results"
template_noresults	String	Default template	Override the default template with a custom Handlebars template for "No search results found"
template_image	String	Default template	Override the default template with a custom Handlebars template for the featured image shown with search results

Pagination

Pagination. Typically below search results.

  searchui.pagination({
    containerId: 'pagination'
  });

Settings that can be passed to the pagination function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for the paging
template	String	Default template	Override the default template with a custom Handlebars template
onResultsScrollTo	"top", "no scrolling"	"top"	Set a scrolling behavior when navigate to a new page of results

To change the number of results shown per page, use AddSearch JS client's setPaging function

Load more results

Button to load more results or an infinite scroll implementation.

  searchui.loadMore({
    containerId: 'loadmore',
    type: AddSearchUI.LOAD_MORE_TYPE.BUTTON
  });

Settings that can be passed to the loadMore function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for the component
template	String	Default template	Override the default template with a custom Handlebars template
type	AddSearchUI.LOAD_MORE_TYPE.BUTTON, AddSearchUI.LOAD_MORE_TYPE.INFINITE_SCROLL	n/a	Require user clicking "More results" button or load automatically on scroll bottom
infiniteScrollElement	object	n/a	If the type is INFINITE_SCROLL, this is the scrollable element. Can be window or an HTML element with overflow: auto;

To change the number of results shown per page, use AddSearch JS client's setPaging function. The same Search UI can have the pagination component for desktop view and loadMore for mobile.

Sort by

Component to change the order of search results.

  searchui.sortBy({
    containerId: 'sortby',
    options: [
      {
        label: 'Sort by relevance',
        sortBy: 'relevance',
        order: 'desc'
      },
      {
        label: 'Oldest first',
        sortBy: 'date',
        order: 'asc'
      },
      {
        label: 'Most expensive first',
        sortBy: 'custom_fields.price',
        order: 'desc'
      }
    ]
  });

Settings that can be passed to the sortBy function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for the paging
template	String	Default template	Override the default template with a custom Handlebars template
type	AddSearchUI.SORTBY_TYPE.SELECT_LIST, AddSearchUI.SORTBY_TYPE.RADIO_GROUP	Select list	"Sort by" menu shown as select list or as a radio button group

The options array can contain objects with following fields:

Key	Possible values	Default value	Description
label	String	n/a	Label text to show
sortBy	relevance, date, custom_field	n/a	The field to sort the search results by
order	desc, asc	desc	Ascending order (a-z or 1-9) or descending order (z-a, 9-1)

Filters

Components to let the user filter search results by URL patterns or custom field values.

  searchui.filters({
    containerId: 'filters',
    type: AddSearchUI.FILTER_TYPE.CHECKBOX_GROUP,
      options: {
        appleProducts: {
          label: 'Apple products',
          filter: {'custom_fields.brand': 'apple'}
        }
    }
  });

Settings that can be passed to the filters function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for filters
type	AddSearchUI.FILTER_TYPE.CHECKBOX_GROUP, AddSearchUI.FILTER_TYPE.RADIO_GROUP, AddSearchUI.FILTER_TYPE.SELECT_LIST, AddSearchUI.FILTER_TYPE.TABS, AddSearchUI.FILTER_TYPE.TAGS, AddSearchUI.FILTER_TYPE.RANGE	n/a	Component's type
template	String	Default templates	Override the default template with a custom Handlebars template
clearOtherFilters	boolean	false	Clear all other filters when the value of this filter changes. Works with RADIO_GROUP, SELECT_LIST, and TABS filters
setSorting	Object	n/a	Set sorting when the value of this filter changes. The object must contain field and order. Works with RADIO_GROUP, SELECT_LIST, and TABS filters.
options	Object	n/a	Object containing filtering options

The options object can contain multiple filtering options. If the type is Tabs, Select list, or Radio group, just one of the options can be activated at any given time. If the filter type is Checkbox or Tags, multiple filters can be activated. The option key (appleProducts in the example above) is shared across filter components. All filters with the same key are enabled and disabled simultaneously. Because of this, you can have several filter components controlling the same filter. For example, radio button list on desktop view and a select list on mobile.

Fields in options:

Key	Possible values	Default value	Description
label	String	n/a	Label shown for the user
filter	Object	n/a	Filter object.

The options object is not applicable if the filter type is AddSearchUI.FILTER_TYPE.RANGE, but following settings should be passed to the filters function:

Key	Possible values	Default value	Description
label	String	n/a	Label shown above range filter. For example, "Select price range"
labelShort	String	n/a	Short label shown in the activeFilters component. For example, "Price"
validator	String	n/a	Regular expression to validate the input. For example, ^[\\d]*$ for numeric field

Facets

Display facets and let the user filter results by facets (i.e. dynamic property filters).

  searchui.facets({
    containerId: 'facets'
  });

Before using this component, add appropriate facets to your client instance so the information is fetched from the search index:

  client.addFacetField('custom_fields.brand');

Settings that can be passed to the facets function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for facets
facetsFilter	function	n/a	Custom JS function that receives facets in an array, removes some of them, and returns a filtered facet array
field	String	n/a	Same field that you passed to the JS client. E.g. custom_fields.brand
sticky	boolean	false	Show all options even if a facet is selected. Options are reset on keyword change
template	String	Default template	Override the default template with a custom Handlebars template

Active filters

Show active filters and facets. Let user remove specific filters or clear everything,

  searchui.activeFilters({
    containerId: 'activefilters'
  });

Settings that can be passed to the activeFilters function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for active filters list
clearAll	boolean	true	Show "clear all filters" button if more than one filter is active
template	String	Default template	Override the default template with a custom Handlebars template

Segmented search results

Show multiple search results lists from several indices or with different filters.

  searchui.segmentedSearchResults({
    containerId: 'segment1',
    client: segmentClient,
    template: segmentTemplate
  });

Settings that can be passed to the segmentedSearchResults function:

Key	Possible values	Default value	Description
containerId	String	n/a	ID of the HTML element that will act as a container for this component
client	AddSearch JS Client instance	n/a	Client with appropriate filters/settings for this segment
template	String	n/a	Handlebars template for this segment

General functions

Execute search

Execute a search query with a specific keyword. Common use cases include links of most popular keywords: Clicking the keyword executes the search.

  searchui.search(keyword);

Clear search

Clear the keyword and enabled filters.

  searchui.clear();

Hide autocomplete

Hide the autocomplete component. For example, a "close" button inside the autocomplete modal would call this function.

  searchui.hideAutocomplete();

Register a custom Handlebars helper

Handlebars Helpers can be used to implement functionality that is not part of the Handlebars language itself. Read more at handlebarsjs.js.

  // This function can be called in a Handlebars template: {{toUpperCase "foo"}}
  searchui.registerHandlebarsHelper('toUpperCase', function(param) {
    return param.toUpperCase();
  });

Analytics

This library sends analytics events to AddSearch Analytics Dashboard when:

• Search results are returned
• No results were found
• A result was clicked

You can add integration for third party analytics software by passing a custom analyticsCallback function in AddSearchClient constructor's configuration object. This function is called with a single parameter containing one of the following JSON objects:

Search results received:

{
  action: 'search', 
  keyword: 'keyword', 
  numberOfResults: 10, // If 0, no results were found
  processingTimeMs: 21 // Time it took to process the query and return search results (in milliseconds)
}

In search-as-you-type implementations the search event is sent after 2,5 second delay in typing or if a result is clicked within this debounce time.

Search result clicked:

{
  action: 'click', 
  keyword: 'keyword', 
  documentId: '...', // Hit's 32-char identifier
  position: 1 // Position of the clicked result. The first result being 1
}

To save clicks reliably before the user's browser leaves the page, it's recommended to use the navigator.sendBeacon method.

Supported web browsers

This library is tested on

• Chrome
• Firefox
• Edge
• Safari 6.1+
• Internet Explorer 11

Development

To modify this library, clone the repository and follow these steps:

Install dependencies

npm install

Code

Re-compile when source files change while developing

npm run watch

Run tests

Run automated tests

npm test

Run automatically when tests change

npm run test -- --watch

Build for production

Build a production bundle. The file is saved under the dist/ folder

npm run build

Support

Feel free to send any questions, ideas, and suggestions at [email protected] or visit addsearch.com for more information.