Search UI Elements

To standardize the search client defined search UI elements were introduced. Whenever some way to display something from search response is needed, the UI element should be created. From Drupal side it is Plugin of type search_ui_element. UI element can have its own configuration, but required properties are: type of the element, region it belongs to and weight.

Some elements can provide their own plugin for widgets.

Currently the following types of search ui elements were implemented:

Search input
Autocomplete
Search result
Pager
Load more
Facet
Search Summary
Exposed Filter
Sorting

You can create your own UI elements as search_ui_element plugins in custom or contrib module.

Retrieve UI Settings

Endpoint for retrieving UI Settings

Exposed filter

Search UI Element for filtering search results with "free" user input

Facet

Facet element is used to display the facets.

Search Input

Search input element is used to display the element that user will use to provide his/her search keywords.

Search result

Search result element is used to display the search result.

Sorting

Allows users to control sorting of results from UI

Search Summary

Search summary displays total number of results and some statistics about the duration of search query execution.

Pager

Pager element is for displaying pager

Guide maintainers