SearchPage class
SearchPage A search page that can be used to search for data
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SearchPage
Constructors
-
SearchPage({Key? key, Color backgroundColor = Colors.white24, Color buttonColor = Colors.white24, Color? iconColor, IconData searchIcon = LineIcons.search, IconData closeIcon = LineIcons.times, IconData backIcon = LineIcons.chevronLeft, BorderRadius borderRadius = const BorderRadius.all(Radius.circular(12)), EdgeInsets padding = const EdgeInsets.symmetric(vertical: 9, horizontal: 15), TextStyle? textStyle, TextStyle? inputTextstyle, Duration? resultsAnimationDuration, num? resultsAnimationOffset, Color? inputBackgroundColor, InputBorder? inputBorder, EdgeInsets? resultPadding, String placeholder = "Search", Border border = const Border(), String initialQuery = "", bool showExit = true, bool liveSearch = true, Widget? searchLeading, Widget? searchTrailing, Widget? emptyScreen, Widget? resultScreen, Widget? errorScreen, Widget? loadingScreen, Widget? header, Widget? history, Future<
List< request(String)?, Future<ISearchable> >List< lazyRequest(String, dynamic)?, Future<ISearchable> >List< suggestions(String)?, num? paginationLimit = 30, dynamic paginationCursor = 1, num? paginationOffset = 1, bool paginateByPageNumber = false, bool enableLazyLoading = false, bool enableLoadMoreScroll = false, Widget? loadMoreWidget, Widget? loadingWidget, required Widget resultBuilder(ISearchable), Widget suggestionsBuilder(ISearchable)?})ISearchable> >
Properties
- backgroundColor → Color
-
final
- backIcon → IconData
-
final
- border → Border
-
final
- borderRadius → BorderRadius
-
final
-
final
- closeIcon → IconData
-
final
- emptyScreen → Widget?
-
final
- enableLazyLoading → bool
-
final
- enableLoadMoreScroll → bool
-
final
- errorScreen → Widget?
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- header → Widget?
-
final
- history → Widget?
-
final
- iconColor → Color?
-
final
- initialQuery → String
-
final
- inputBackgroundColor → Color?
-
final
- inputBorder → InputBorder?
-
final
- inputTextstyle → TextStyle?
-
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
lazyRequest
↔ (Future<
List< Function(String, dynamic)?)ISearchable> > -
getter/setter pair
- liveSearch → bool
-
final
- loadingScreen → Widget?
-
final
- loadingWidget → Widget?
-
final
- loadMoreWidget → Widget?
-
final
- padding → EdgeInsets
-
final
- paginateByPageNumber → bool
-
final
- paginationCursor → dynamic
-
final
- paginationLimit → num?
-
final
- paginationOffset → num?
-
final
- placeholder → String
-
final
-
request
↔ (Future<
List< Function(String)?)ISearchable> > -
getter/setter pair
- resultBuilder → Widget Function(ISearchable)
-
final
- resultPadding → EdgeInsets?
-
final
- resultsAnimationDuration → Duration?
-
final
- resultsAnimationOffset → num?
-
final
- resultScreen → Widget?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- searchIcon → IconData
-
final
- searchLeading → Widget?
-
final
- searchTrailing → Widget?
-
final
- showExit → bool
-
final
-
suggestions
→ (Future<
List< Function(String)?)ISearchable> > -
final
- suggestionsBuilder → (Widget Function(ISearchable)?)
-
final
- textStyle → TextStyle?
-
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< SearchPage> -
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
Static Methods
-
createRoute<
T> (Widget child, {String? routeName}) → Route< T> -
searchBarButton(
BuildContext context, {Color backgroundColor = Colors.white, Color buttonColor = Colors.white24, IconData searchIcon = LineIcons.search, IconData closeIcon = LineIcons.times, IconData backIcon = LineIcons.chevronLeft, Color? iconColor, BorderRadius borderRadius = const BorderRadius.all(Radius.circular(12)), EdgeInsets padding = const EdgeInsets.symmetric(vertical: 9, horizontal: 15), EdgeInsets? resultPadding, TextStyle? textStyle, TextStyle? inputTextstyle, Color? inputBackgroundColor, InputBorder? inputBorder, String placeholder = "Search", Border border = const Border(), String initialQuery = "", bool showExit = true, Duration? resultsAnimationDuration, num? resultsAnimationOffset, Widget? searchLeading, Widget? searchTrailing, Widget? emptyScreen, Widget? resultScreen, Widget? errorScreen, Widget? loadingScreen, Widget? header, Widget? history, dynamic paginationCursor, num? paginationLimit, bool enableLazyLoading = true, bool enableLoadMoreScroll = true, bool liveSearch = true, num? paginationOffset = 1, bool paginateByPageNumber = false, Widget? loadMoreWidget, Widget? loadingWidget, Widget resultBuilder(ISearchable)?, Widget suggestionsBuilder(ISearchable)?, Future< List< suggestions(String)?, Future<ISearchable> >List< request(String)?, Future<ISearchable> >List< lazyRequest(String, dynamic)?}) → WidgetISearchable> > -
showSearchPage<
T> ({required BuildContext context, Color backgroundColor = Colors.white, Color buttonColor = Colors.white24, IconData searchIcon = LineIcons.search, IconData closeIcon = LineIcons.times, IconData backIcon = LineIcons.chevronLeft, Color? iconColor, BorderRadius borderRadius = const BorderRadius.all(Radius.circular(12)), EdgeInsets padding = const EdgeInsets.symmetric(vertical: 9, horizontal: 15), EdgeInsets? resultPadding, TextStyle? textStyle, TextStyle? inputTextstyle, Duration? resultsAnimationDuration, num? resultsAnimationOffset, Color? inputBackgroundColor, InputBorder? inputBorder, String placeholder = "Search", Border border = const Border(), String? query = '', bool liveSearch = true, String initialQuery = "", bool showExit = true, Widget? searchLeading, Widget? searchTrailing, Widget? emptyScreen, Widget? resultScreen, Widget? errorScreen, Widget? loadingScreen, Widget? header, Widget? history, dynamic paginationCursor, num? paginationLimit, bool enableLazyLoading = false, bool enableLoadMoreScroll = false, bool paginateByPageNumber = false, num? paginationOffset = 1, Widget? loadMoreWidget, Widget? loadingWidget, required Widget resultBuilder(ISearchable), Widget suggestionsBuilder(ISearchable)?, Future< List< suggestions(String)?, Future<ISearchable> >List< request(String)?, Future<ISearchable> >List< lazyRequest(String, dynamic)?}) → Future<ISearchable> >T?>