FirestoreSearchScaffold class

Inheritance

Constructors

FirestoreSearchScaffold({PreferredSizeWidget? appBarBottom, Widget scaffoldBody = const Center(child: Text('Add a scaffold body')), Color? appBarBackgroundColor, Color? backButtonColor, Color? clearSearchButtonColor, Color? searchBackgroundColor = Colors.white, Color? searchBodyBackgroundColor = Colors.white, Color? searchTextColor, Color? searchTextHintColor, Color? scaffoldBackgroundColor, bool showSearchIcon = false, Color? searchIconColor, String? appBarTitle, Color? appBarTitleColor, required String firestoreCollectionName, required String? searchBy, required List dataListFromSnapshot(QuerySnapshot<Object?>), Widget builder(BuildContext, AsyncSnapshot)?, int limitOfRetrievedData = 10})
Creates a scaffold with a search AppBar and integrated cloud_firestore search.
const

Properties

appBarBackgroundColor → Color?
final
appBarBottom → PreferredSizeWidget?
Widget that will be displayed in the bottom of app bar
final
appBarTitle → String?
final
appBarTitleColor → Color?
final
backButtonColor → Color?
final
builder → (Widget Function(BuildContext, AsyncSnapshot)?)
Refers to the builder parameter of StreamBuilder used to
final
clearSearchButtonColor → Color?
final
dataListFromSnapshot → List Function(QuerySnapshot<Object?>)
final
firestoreCollectionName → String?
Name of the cloud_firestore collection you
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
limitOfRetrievedData → int
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaffoldBackgroundColor → Color?
final
scaffoldBody → Widget
final
searchBackgroundColor → Color?
final
searchBodyBackgroundColor → Color?
final
searchBy → String?
final
searchIconColor → Color?
final
searchTextColor → Color?
final
searchTextHintColor → Color?
final
showSearchIcon → bool
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _FirestoreSearchScaffoldState
Creates the mutable state for this widget at a given location in the tree.
override
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