ReactiveSearch-Vue provides Vue UI components for Elasticsearch. This document explains the different kinds of components offered by the library and walks throughs scenarios of when to use which component.
Components are divided into four broad categories:
List componentsrepresent all kinds of list related UI components which typically create a term query.
Range componentsrepresent all kinds of numbers and dates related UI components which typically create a range based query.
Search componentsrepresent searchbar UIs, which typically apply search on full-text data.
Result componentsare components for displaying results (aka hits) from queries created by other components.
1. List Components
List is one of the most used data-driven UI displays and hence naturally, we offer a variety of ways to use this UI style.
String or Text Datatype
The following are all the possible UI components for a
String datatype field in your appbase.io app. These apply a term or terms database query on the selected item(s).
The components can also be used with
Numeric datatype fields.
SingleList is useful for displaying a list of values where only one item can be selected at a time, and the values are retrieved by a database query on the field specified in the dataField prop.
MultiList is useful for displaying a list of values where multiple values can be selected at a time. Similar to SingleList, these values are retrieved by a database query on the field specified in the dataField prop.
2. Range Components
The following are all the possible UI components for a numeric datatype field in your appbase.io app. These apply a range database query on the selected item(s).
SingleRange displays a curated list of items where only one item can be selected at a time. Each item represents a range of values, specified in the data prop of the component.
3. Search Components
The following are UI components that represent searchbar UIs. The datatype for the
dataField in these components should be a
Keyword, along with custom analyzer (like ngrams) based mappings defined in sub-fields.
SearchBox displays a search input box.
4. Result Components
Result components are used for displaying the results (aka hits).
How do result components fetch results by combining queries from multiple components?
They do this via react prop, which allows each component to specify their dependent components using a DSL that mirrors Elasticsearch's compound query DSL for bool clause.
ReactiveList displays the results in a configurable list layout. This is a more flexible display component (used internally by both ResultList and ResultCard) that allows more customization than ResultList and ResultCard.
5. Base Components
Base components are useful primitive components that don’t belong to any of the above categories.
SelectedFilters is a selection component to render the selected values from other components with a "Clear All" option.