AppWideSearchDelegate class

A customizable search delegate that integrates with Riverpod.

This delegate provides a complete search experience with suggestions, results, and history management. It can be customized by overriding various builder methods.

Inheritance

Constructors

AppWideSearchDelegate.new({required WidgetRef ref, String? hintText, Widget resultBuilder(BuildContext, SearchResult)?, Widget suggestionBuilder(BuildContext, List<String>)?, Widget emptyBuilder(BuildContext, String)?})
Creates an app-wide search delegate.

Properties

autocorrect → bool
Whether to enable autocorrection.
finalinherited
automaticallyImplyLeading ↔ bool?
Controls whether we should try to imply the leading widget if null.
getter/setter pairinherited
emptyBuilder → Widget Function(BuildContext, String)?
Custom builder for empty state.
final
enableSuggestions → bool
Whether to show input suggestions as the user types.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
hintText → String?
Custom hint text for the search field.
final
keyboardType → TextInputType?
The type of action button to use for the keyboard.
finalinherited
leadingWidth ↔ double?
Defines the width of AppBar.leading widget.
getter/setter pairinherited
query ↔ String
The current query string shown in the AppBar.
getter/setter pairinherited
ref → WidgetRef
Reference to the Riverpod ProviderContainer.
final
resultBuilder → Widget Function(BuildContext, SearchResult)?
Custom builder for search results.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchFieldDecorationTheme → InputDecorationTheme?
The InputDecorationTheme used to configure the search field's visuals.
finalinherited
searchFieldLabel → String?
The hint text that is shown in the search field when it is empty.
no setteroverride
searchFieldStyle → TextStyle?
The style of the searchFieldLabel.
finalinherited
suggestionBuilder → Widget Function(BuildContext, List<String>)?
Custom builder for suggestions.
final
textInputAction → TextInputAction
The text input action configuring the soft keyboard to a particular action button.
finalinherited
transitionAnimation → Animation<double>
Animation triggered when the search pages fades in or out.
no setterinherited

Methods

appBarTheme(BuildContext context) → ThemeData
The theme used to configure the search page.
inherited
buildActions(BuildContext context) → List<Widget>
Widgets to display after the search query in the AppBar.
override
buildBottom(BuildContext context) → PreferredSizeWidget?
Widget to display across the bottom of the AppBar.
inherited
buildFlexibleSpace(BuildContext context) → Widget?
Widget to display a flexible space in the AppBar.
inherited
buildLeading(BuildContext context) → Widget
A widget to display before the current query in the AppBar.
override
buildResults(BuildContext context) → Widget
The results shown after the user submits a search from the search page.
override
buildSuggestions(BuildContext context) → Widget
Suggestions shown in the body of the search page while the user types a query into the search field.
override
close(BuildContext context, SearchItem? result) → void
Closes the search page and returns to the underlying route.
inherited
dispose() → void
Releases the resources.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
showResults(BuildContext context) → void
Transition from the suggestions returned by buildSuggestions to the query results returned by buildResults.
inherited
showSuggestions(BuildContext context) → void
Transition from showing the results returned by buildResults to showing the suggestions returned by buildSuggestions.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited