SearchWidgetConnector<S, ViewModel> class
SearchWidgetConnector represents a search widget that can be used to bind to different kinds of search UI widgets.
It uses the SearchController
class to bind any UI widget to be able to query appbase.io declaratively. Some examples of components you can bind this with:
- a category filter widget,
- a search bar widget,
- a price range widget,
- a location filter widget,
- a widget to render the search results.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- SearchWidgetConnector
Constructors
-
SearchWidgetConnector({Key? key, required ViewModelBuilder<
ViewModel> builder, required String id, List<KeysToSubscribe> ? subscribeTo, bool? triggerQueryOnInit, bool? shouldListenForChanges, bool? destroyOnDispose, String? credentials, String? index, String? url, AppbaseSettings? appbaseConfig, TransformRequest? transformRequest, TransformResponse? transformResponse, Map<String, String> ? headers, QueryType? type, Map<String, dynamic> ? react, String? queryFormat, dynamic dataField, String? categoryField, String? categoryValue, String? nestedField, int? from, int? size, SortType? sortBy, String? aggregationField, int? aggregationSize, Map? after, bool? includeNullValues, List<String> ? includeFields, List<String> ? excludeFields, dynamic fuzziness, bool? searchOperators, bool? highlight, dynamic highlightField, Map? customHighlight, int? interval, List<String> ? aggregations, String? missingLabel, bool? showMissing, bool? enableSynonyms, String? selectAllLabel, bool? pagination, bool? queryString, Map defaultQuery(dynamic searchController)?, Map customQuery(dynamic searchController)?, Future beforeValueChange(dynamic value)?, void onValueChange(dynamic next, {dynamic prev})?, void onResults(Results next, {Results prev})?, void onAggregationData(Aggregations next, {Aggregations prev})?, void onError(dynamic error)?, void onRequestStatusChange(String next, {String prev})?, void onQueryChange(List<Map> ? next, {List<Map> ? prev})?, bool? enablePopularSuggestions, int? maxPopularSuggestions, bool? showDistinctSuggestions, bool? preserveResults, bool clearOnQueryChange = false, dynamic value, String? distinctField, Map? distinctFieldConfig, Duration httpRequestTimeout = const Duration(seconds: 30), CompoundClauseType? compoundClause})
Properties
- after → Map?
-
This property can be used to implement the pagination for
aggregations
.final - aggregationField → String?
-
It enables you to get
DISTINCT
results (useful when you are dealing with sessions, events, and logs type data).final -
aggregations
→ List<
String> ? -
It helps you to utilize the built-in aggregations for
QueryType.range
type of widgets directly, valid values are:final - aggregationSize → int?
-
To set the number of buckets to be returned by aggregations.
final
- appbaseConfig → AppbaseSettings?
-
It allows you to customize the analytics experience when appbase.io is used as a backend.
final
- beforeValueChange → (Future Function(dynamic value)?)
-
It is a callback function which accepts component's future value as a
parameter and returns a Future.
final
-
builder
→ ViewModelBuilder<
ViewModel> -
Build a Widget using the BuildContext and
ViewModel
final - categoryField → String?
-
Index field mapped to the category value.
final
- categoryValue → String?
-
This is the selected category value. It is used for informing the search result.
final
- clearOnQueryChange → bool
-
When set to
true
, the controller's value would get cleared whenever the query of a watcher controller(which is set via react prop) changes.final - compoundClause ↔ CompoundClauseType?
-
Configure whether the DSL query is generated with the compound clause of
CompoundClauseType.must
orCompoundClauseType.filter
. If nothing is passed the default is to useCompoundClauseType.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)getter/setter pair - credentials → String?
-
Basic Auth credentials if required for authentication purposes.
final
- customHighlight → Map?
-
It can be used to set the custom highlight settings.
final
- customQuery → (Map Function(dynamic searchController)?)
-
It takes
SearchController
instance as parameter and returns the query to be applied to the dependent widgets byreact
prop, as defined in Elasticsearch Query DSL.final - dataField → dynamic
-
The index field(s) to be connected to the component’s UI view.
final
- defaultQuery → (Map Function(dynamic searchController)?)
-
It is a callback function that takes the
SearchController
instance as parameter 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.final - destroyOnDispose → bool?
-
If set to
false
then after dispose the component will not get removed from seachbase context i.e can actively participate in query generation.final - distinctField → String?
-
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 - https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html
final
- distinctFieldConfig → Map?
-
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 - https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html
final
- enablePopularSuggestions → bool?
-
It can be useful to curate search suggestions based on actual search queries that your users are making.
final
- enableSynonyms → bool?
-
This property can be used to control (enable/disable) the synonyms behavior for a particular query.
final
-
excludeFields
→ List<
String> ? -
final
- from → int?
-
To define from which page to start the results, it is important to implement pagination.
final
- fuzziness → dynamic
-
Useful for showing the correct results for an incorrect search parameter by taking the fuzziness into account.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
headers
→ Map<
String, String> ? -
Set custom headers to be sent with each server request as key/value pairs.
final
- highlight → bool?
-
To define whether highlighting should be enabled in the returned results.
final
- highlightField → dynamic
-
If highlighting is enabled, this property allows specifying the fields which should be returned with the matching highlights.
final
- httpRequestTimeout ↔ Duration
-
This prop is used to set the timeout value for HTTP requests.
Defaults to 30 seconds.
getter/setter pair
- id → String
-
A unique identifier of the component, can be referenced in other widgets'
react
prop to reactively update data.final -
includeFields
→ List<
String> ? -
final
- includeNullValues → bool?
-
If you have sparse data or documents or items not having the value in the specified field or mapping, then this prop enables you to show that data.
final
- index → String?
-
Refers to an index of the Elasticsearch cluster.
final
- interval → int?
-
To set the histogram bar interval for
QueryType.range
type of widgets, applicable when aggregations value is set to["histogram"]
.final - key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- maxPopularSuggestions → int?
-
It can be used to configure the size of popular suggestions.
final
- missingLabel → String?
-
It allows you to specify a custom label to show when showMissing is set to
true
.final - nestedField → String?
-
Sets the
nested
field path that allows an array of objects to be indexed in a way that can be queried independently of each other.final - onAggregationData → (void Function(Aggregations next, {Aggregations prev})?)
-
It can be used to listen for the
aggregationData
property changes.final - onError → (void Function(dynamic error)?)
-
It gets triggered in case of an error occurs while fetching results.
final
-
onQueryChange
→ (void Function(List<
Map> ? next, {List<Map> ? prev})?) -
It is a callback function which accepts widget's nextQuery and prevQuery as parameters.
final
- onRequestStatusChange → (void Function(String next, {String prev})?)
-
It can be used to listen for the request status changes.
final
- onResults → (void Function(Results next, {Results prev})?)
-
It can be used to listen for the
results
changes.final - onValueChange → (void Function(dynamic next, {dynamic prev})?)
-
It is called every-time the widget's value changes.
final
- pagination → bool?
-
This property allows you to implement the
pagination
forQueryType.term
type of queries.final - preserveResults → bool?
-
It set to
true
then it preserves the previously loaded results data that can be used to persist pagination or implement infinite loading.final - queryFormat → String?
-
Sets the query format, can be or or and.
final
- queryString → bool?
-
If set to
true
than it allows you to create a complex search that includes wildcard characters, searches across multiple fields, and more.final -
react
→ Map<
String, dynamic> ? -
It is useful for components whose data view should reactively update when on or more dependent components change their states.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- searchOperators → bool?
-
If set to
true
, then you can use special characters in the search query to enable the advanced search.final - selectAllLabel → String?
-
This property allows you to add a new property in the list with a particular value in such a way that
when selected i.e
value
is similar/contains to that label(selectAllLabel
) thenQueryType.term
query will make sure that thefield
exists in theresults
.final - shouldListenForChanges → bool?
-
It can be used to prevent state updates.
final
- showDistinctSuggestions → bool?
-
To display one suggestion per document.
final
- showMissing → bool?
-
When set to
true
then it also retrieves the aggregations for missing fields.final - size → int?
-
Number of suggestions and results to fetch per request.
final
- sortBy → SortType?
-
Sorts the results by either
SortType.asc
,SortType.desc
orSortType.count
order.final -
subscribeTo
→ List<
KeysToSubscribe> ? -
This property allows to define a list of properties of
SearchController
class which can trigger the re-build when any changes happen.final - transformRequest → TransformRequest?
-
Enables transformation of network request before execution.
final
- transformResponse → TransformResponse?
-
Enables transformation of search network response before rendering them.
final
- triggerQueryOnInit → bool?
-
It can be used to prevent the default query execution at the time of initial build.
final
- type → QueryType?
-
This property represents the type of the query which is defaults to
QueryType.search
, valid values areQueryType.search
,QueryType.term
,QueryType.range
&QueryType.geo
.final - url → String?
-
URL for the Elasticsearch cluster.
final
- value → dynamic
-
Represents the value for a particular
QueryType
.final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's location in the tree.
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNode
objects describing this node's children.inherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited