FirestoreSearchResults class

Inheritance

Constructors

FirestoreSearchResults.builder({required String? tag, required String? firestoreCollectionName, required String? searchBy, int limitOfRetrievedData = 10, required List dataListFromSnapshot(QuerySnapshot<Object?>), Widget builder(BuildContext, AsyncSnapshot)?, Widget? initialBody, Color? resultsBodyBackgroundColor = Colors.white, Key? key})
Returns the results from firestore and displays the data using builder function provided by the developer This widget can be used anywhere is the widget tree, and the results will correspond the searchQuery of FirestoreSearchBar linked by tag parameter
const

Properties

builder → (Widget Function(BuildContext, AsyncSnapshot)?)
Refers to the builder parameter of StreamBuilder used to
final
dataListFromSnapshot → List Function(QuerySnapshot<Object?>)
Function that converts QuerySnapshot to a list of data model as required
final
firestoreCollectionName → String?
Name of the cloud_firestore collection you
final
hashCode → int
The hash code for this object.
no setterinherited
initialBody → Widget?
When search text field is empty, this widget is displayed
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
limitOfRetrievedData → int
Limit of firestore documents return is search results
final
resultsBodyBackgroundColor → Color?
Color for background of results body
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchBy → String?
The searchQuery is matched against this key value in the firestore document
final
tag → String?
Unique identifier for FirestoreSearchController used by FirestoreSearchBar and FirestoreSearchResults to enable data sharing
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