diff --git a/packages/flutter/lib/src/material/search_anchor.dart b/packages/flutter/lib/src/material/search_anchor.dart index 5855b5506f..f7f6bc8c30 100644 --- a/packages/flutter/lib/src/material/search_anchor.dart +++ b/packages/flutter/lib/src/material/search_anchor.dart @@ -147,6 +147,7 @@ class SearchAnchor extends StatefulWidget { this.viewOnChanged, this.viewOnSubmitted, this.viewOnClose, + this.viewOnOpen, required this.builder, required this.suggestionsBuilder, this.textInputAction, @@ -173,6 +174,7 @@ class SearchAnchor extends StatefulWidget { ValueChanged? onSubmitted, ValueChanged? onChanged, VoidCallback? onClose, + VoidCallback? onOpen, MaterialStateProperty? barElevation, MaterialStateProperty? barBackgroundColor, MaterialStateProperty? barOverlayColor, @@ -375,6 +377,9 @@ class SearchAnchor extends StatefulWidget { /// Called when the search view is closed. final VoidCallback? viewOnClose; + /// Called when the search view is opened. + final VoidCallback? viewOnOpen; + /// Called to create a widget which can open a search view route when it is tapped. /// /// The widget returned by this builder is faded out when it is tapped. @@ -465,6 +470,7 @@ class _SearchAnchorState extends State { viewOnChanged: widget.viewOnChanged, viewOnSubmitted: widget.viewOnSubmitted, viewOnClose: widget.viewOnClose, + viewOnOpen: widget.viewOnOpen, viewLeading: widget.viewLeading, viewTrailing: widget.viewTrailing, viewHintText: widget.viewHintText, @@ -544,6 +550,7 @@ class _SearchViewRoute extends PopupRoute<_SearchViewRoute> { this.viewOnChanged, this.viewOnSubmitted, this.viewOnClose, + this.viewOnOpen, this.toggleVisibility, this.textDirection, this.viewBuilder, @@ -576,6 +583,7 @@ class _SearchViewRoute extends PopupRoute<_SearchViewRoute> { final ValueChanged? viewOnChanged; final ValueChanged? viewOnSubmitted; final VoidCallback? viewOnClose; + final VoidCallback? viewOnOpen; final ValueGetter? toggleVisibility; final TextDirection? textDirection; final ViewBuilder? viewBuilder; @@ -641,6 +649,7 @@ class _SearchViewRoute extends PopupRoute<_SearchViewRoute> { updateViewConfig(anchorKey.currentContext!); updateTweens(anchorKey.currentContext!); toggleVisibility?.call(); + viewOnOpen?.call(); return super.didPush(); } @@ -1193,6 +1202,7 @@ class _SearchAnchorWithSearchBar extends SearchAnchor { ValueChanged? onChanged, ValueChanged? onSubmitted, VoidCallback? onClose, + VoidCallback? onOpen, required super.suggestionsBuilder, super.textInputAction, super.keyboardType, @@ -1207,6 +1217,7 @@ class _SearchAnchorWithSearchBar extends SearchAnchor { viewOnSubmitted: onSubmitted, viewOnChanged: onChanged, viewOnClose: onClose, + viewOnOpen: onOpen, builder: (BuildContext context, SearchController controller) { return SearchBar( constraints: constraints, @@ -1248,6 +1259,9 @@ class _SearchAnchorWithSearchBar extends SearchAnchor { /// with methods such as [openView] and [closeView]. It can also control the text in the /// input field. /// +/// To observe open/close state changes of search view, provide +/// [SearchAnchor.viewOnOpen] and/or [SearchAnchor.viewOnClose] callbacks. +/// /// See also: /// /// * [SearchAnchor], a widget that defines a region that opens a search view. diff --git a/packages/flutter/test/material/search_anchor_test.dart b/packages/flutter/test/material/search_anchor_test.dart index e20f8e9186..4e7eec9096 100644 --- a/packages/flutter/test/material/search_anchor_test.dart +++ b/packages/flutter/test/material/search_anchor_test.dart @@ -3911,6 +3911,102 @@ void main() { // No exception. }); + + testWidgets('SearchAnchor viewOnOpen is called when the search view is opened', ( + WidgetTester tester, + ) async { + String searchViewState = 'Idle'; + await tester.pumpWidget( + MaterialApp( + home: Material( + child: Center( + child: SearchAnchor( + viewOnClose: () { + searchViewState = 'Closed'; + }, + viewOnOpen: () { + searchViewState = 'Opened'; + }, + builder: (BuildContext context, SearchController controller) { + return IconButton( + icon: const Icon(Icons.search), + onPressed: () { + controller.openView(); + }, + ); + }, + suggestionsBuilder: (BuildContext context, SearchController controller) { + return List.generate(5, (int index) { + final String item = 'item $index'; + return ListTile( + leading: const Icon(Icons.history), + title: Text(item), + trailing: const Icon(Icons.chevron_right), + onTap: () {}, + ); + }); + }, + ), + ), + ), + ), + ); + + expect(find.byIcon(Icons.search), findsOneWidget); + // Open search view. + await tester.tap(find.byIcon(Icons.search)); + await tester.pump(); + expect(searchViewState, 'Opened'); + + // Pop search view route. + await tester.tap(find.backButton()); + await tester.pump(); + expect(searchViewState, 'Closed'); + }); + + testWidgets('SearchAnchor.bar onOpen is called when the search view is opened', ( + WidgetTester tester, + ) async { + String searchViewState = 'Idle'; + await tester.pumpWidget( + MaterialApp( + home: Material( + child: Center( + child: SearchAnchor.bar( + onClose: () { + searchViewState = 'Closed'; + }, + onOpen: () { + searchViewState = 'Opened'; + }, + suggestionsBuilder: (BuildContext context, SearchController controller) { + return List.generate(5, (int index) { + final String item = 'item $index'; + return ListTile( + leading: const Icon(Icons.history), + title: Text(item), + trailing: const Icon(Icons.chevron_right), + onTap: () {}, + ); + }); + }, + ), + ), + ), + ), + ); + + expect(find.byIcon(Icons.search), findsOneWidget); + // Open search view. + await tester.tap(find.byIcon(Icons.search)); + await tester.pump(); + expect(searchViewState, 'Opened'); + + // Pop search view route. + await tester.tap(find.backButton()); + await tester.pump(); + expect(searchViewState, 'Closed'); + }); } Future checkSearchBarDefaults(