Skip to content

Add an example for SearchBar#124992

Merged
auto-submit[bot] merged 8 commits intoflutter:masterfrom
QuncCccccc:add_search_bar_example
Apr 17, 2023
Merged

Add an example for SearchBar#124992
auto-submit[bot] merged 8 commits intoflutter:masterfrom
QuncCccccc:add_search_bar_example

Conversation

@QuncCccccc
Copy link
Contributor

@QuncCccccc QuncCccccc commented Apr 17, 2023 •
edited
Loading

This PR is to:

  • Update API doc for SearchBar.
  • Add an example to show how to use a SearchBar as the builder of the SearchAnchor.

Pre-launch Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I read the [Tree Hygiene] wiki page, which explains my responsibilities.
  • I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
  • I signed the [CLA].
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is [test-exempt].
  • All existing and new tests are passing.

@flutter-dashboard flutter-dashboard bot added d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos documentation f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. c: contributor-productivity Team-specific productivity, code health, technical debt. labels Apr 17, 2023
@QuncCccccc QuncCccccc requested a review from HansMuller April 17, 2023 20:37
@QuncCccccc QuncCccccc marked this pull request as ready for review April 17, 2023 20:37
@QuncCccccc QuncCccccc removed the request for review from HansMuller April 17, 2023 20:37
@QuncCccccc QuncCccccc force-pushed the add_search_bar_example branch from 6bcdb64 to e69bb9d Compare April 17, 2023 20:44
@QuncCccccc QuncCccccc requested a review from HansMuller April 17, 2023 20:47
HansMuller
HansMuller reviewed Apr 17, 2023
View reviewed changes
packages/flutter/lib/src/material/search_anchor.dart Outdated
/// Search bars include a [leading] Search icon, a text input field and optional
/// [trailing] icons. A search bar is typically used to open a search view.
/// It is the default trigger for a search view.
/// Search bars typically consist of a [leading] search icon, a text input field
Copy link
Contributor

@HansMuller HansMuller Apr 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still a bit confusing because it implies that SearchBar is a SearchAnchorChildBuilder and because it doesn't make it obvious that a SearchBar is the thing that the user taps to get a search view route. Here's a suggestion on how to describe SearchBar:

A SearchBar looks like a TextField. Tapping a SearchBar typically shows a "search view" route: a route with the search bar at the top and a list of suggested completions for the search bar's text below. SearchBars are usually created by a [SearchAnchor.builder]. The builder provides a [SearchController] that's used by the search bar's [SearchBar.onTap] callback to show the search view and to hide it when the user selects a suggestion.

Copy link
Contributor Author

@QuncCccccc QuncCccccc Apr 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is much better than my version🥲. Just updated. Thanks a lot for the suggestion!

packages/flutter/lib/src/material/search_anchor.dart Outdated
/// a separate high-level action (such as current location) or an overflow menu.
///
/// {@tool dartpad}
/// This example shows how to use a [SearchBar] as the builder of the [SearchAnchor].
Copy link
Contributor

@HansMuller HansMuller Apr 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SearchBar isn't a SearchAnchorChildBuilder

Copy link
Contributor Author

@QuncCccccc QuncCccccc Apr 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah right, it should be the builder's return value instead of the builder. Just updated.

HansMuller
HansMuller approved these changes Apr 17, 2023
View reviewed changes
Copy link
Contributor

@HansMuller HansMuller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@HansMuller HansMuller added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 17, 2023
@auto-submit auto-submit bot merged commit 6e85113 into flutter:master Apr 17, 2023
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 18, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 18, 2023
@engine-flutter-autoroll
6e85113 Add an example for SearchBar (flutter/flutter#124992)
4503a66
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 18, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 18, 2023
@engine-flutter-autoroll
6e85113 Add an example for SearchBar (flutter/flutter#124992)
0c48b64
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 18, 2023
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 18, 2023
@engine-flutter-autoroll
6e85113 Add an example for SearchBar (flutter/flutter#124992)
b58c7b0
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Apr 18, 2023
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 18, 2023
@engine-flutter-autoroll
6e85113 Add an example for SearchBar (flutter/flutter#124992)
f385dcd
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Apr 18, 2023
@engine-flutter-autoroll
Roll Flutter from 15cb1f8 to 42fb0b2 (19 revisions) (#3756)
37adba7 
flutter/flutter@15cb1f8...42fb0b2

2023-04-18 [email protected] Fix text theme dart fix cases (flutter/flutter#125052)
2023-04-18 [email protected] Update the copy icon in snippets and samples to use the standard one (flutter/flutter#123651)
2023-04-18 [email protected] Remove unused context parameter (flutter/flutter#124254)
2023-04-18 [email protected] iOS spell check cursor placement (flutter/flutter#124875)
2023-04-18 [email protected] Roll Flutter Engine from d2973619074e to 55bb065c607b (1 revision) (flutter/flutter#125047)
2023-04-18 [email protected] Stop running "_impeller_" benchmark variants (flutter/flutter#125044)
2023-04-18 [email protected] Roll Packages from 0277f2a to faf53fb (7 revisions) (flutter/flutter#125040)
2023-04-18 [email protected] Roll Flutter Engine from c4396f9f602f to d2973619074e (6 revisions) (flutter/flutter#125039)
2023-04-18 [email protected] Roll pub packages (flutter/flutter#125005)
2023-04-18 [email protected] [InputDatePickerFormField] adds acceptEmptyDate to InputDatePickerFormField Widget (flutter/flutter#124143)
2023-04-18 [email protected] relayout active ListWheelScrollView children every performLayout (flutter/flutter#124476)
2023-04-18 [email protected] Roll Flutter Engine from 4a603aaff32e to c4396f9f602f (2 revisions) (flutter/flutter#125007)
2023-04-18 [email protected] Roll Flutter Engine from 20034a8d62c4 to 4a603aaff32e (2 revisions) (flutter/flutter#125004)
2023-04-18 [email protected] Add optional axis specifier to static scrollable methods (flutter/flutter#124894)
2023-04-17 [email protected] Update usage of standalone`pub` executable in flutter_tools testing docs (flutter/flutter#124898)
2023-04-17 [email protected] Add Harish Anbalagan to AUTHORS (flutter/flutter#124684)
2023-04-17 [email protected] Roll Flutter Engine from b2d07388ceb6 to 20034a8d62c4 (7 revisions) (flutter/flutter#125001)
2023-04-17 [email protected] Add an example for SearchBar (flutter/flutter#124992)
2023-04-17 [email protected] SelectionContainer's listeners can remove itself during listener callâ�¦ (flutter/flutter#124624)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
This was referenced Apr 20, 2023
Closed
Closed
@HansMuller HansMuller mentioned this pull request Apr 21, 2023
Closed
@reidbaker reidbaker mentioned this pull request Apr 21, 2023
Merged
8 tasks
nploi pushed a commit to nploi/packages that referenced this pull request Jul 16, 2023
@engine-flutter-autoroll @nploi
Roll Flutter from 15cb1f8 to 42fb0b2 (19 revisions) (flutter#3756)
34affeb 
flutter/flutter@15cb1f8...42fb0b2

2023-04-18 [email protected] Fix text theme dart fix cases (flutter/flutter#125052)
2023-04-18 [email protected] Update the copy icon in snippets and samples to use the standard one (flutter/flutter#123651)
2023-04-18 [email protected] Remove unused context parameter (flutter/flutter#124254)
2023-04-18 [email protected] iOS spell check cursor placement (flutter/flutter#124875)
2023-04-18 [email protected] Roll Flutter Engine from d2973619074e to 55bb065c607b (1 revision) (flutter/flutter#125047)
2023-04-18 [email protected] Stop running "_impeller_" benchmark variants (flutter/flutter#125044)
2023-04-18 [email protected] Roll Packages from 0277f2a to faf53fb (7 revisions) (flutter/flutter#125040)
2023-04-18 [email protected] Roll Flutter Engine from c4396f9f602f to d2973619074e (6 revisions) (flutter/flutter#125039)
2023-04-18 [email protected] Roll pub packages (flutter/flutter#125005)
2023-04-18 [email protected] [InputDatePickerFormField] adds acceptEmptyDate to InputDatePickerFormField Widget (flutter/flutter#124143)
2023-04-18 [email protected] relayout active ListWheelScrollView children every performLayout (flutter/flutter#124476)
2023-04-18 [email protected] Roll Flutter Engine from 4a603aaff32e to c4396f9f602f (2 revisions) (flutter/flutter#125007)
2023-04-18 [email protected] Roll Flutter Engine from 20034a8d62c4 to 4a603aaff32e (2 revisions) (flutter/flutter#125004)
2023-04-18 [email protected] Add optional axis specifier to static scrollable methods (flutter/flutter#124894)
2023-04-17 [email protected] Update usage of standalone`pub` executable in flutter_tools testing docs (flutter/flutter#124898)
2023-04-17 [email protected] Add Harish Anbalagan to AUTHORS (flutter/flutter#124684)
2023-04-17 [email protected] Roll Flutter Engine from b2d07388ceb6 to 20034a8d62c4 (7 revisions) (flutter/flutter#125001)
2023-04-17 [email protected] Add an example for SearchBar (flutter/flutter#124992)
2023-04-17 [email protected] SelectionContainer's listeners can remove itself during listener callâ�¦ (flutter/flutter#124624)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@HansMuller HansMuller HansMuller approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

autosubmit Merge PR when tree becomes green via auto submit App c: contributor-productivity Team-specific productivity, code health, technical debt. d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@QuncCccccc @HansMuller