Updated SearchDelegate to follow custom InputDecorationTheme #55209

gildaswise · 2020-04-20T15:48:20Z

Description

Currently, if you start using InputDecorationTheme in your app, SearchDelegate will follow it and work as intended, but if you're using something like a OutlineInputBorder, it fails to display it properly, and even overwriting appBarTheme with another InputDecorationTheme doesn't help, because the current version of SearchDelegate does not apply it as a Theme widget.

This PR makes it so AppBar is inside a Theme widget that applies the appBarTheme property to the whole tree. It also moves the InputDecorationTheme changes to that property, so the only thing in decoration: is hintText, and every other theming property should be added to appBarTheme or searchFieldDecoration instead of directly there.

Related Issues

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I signed the [CLA].
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I updated/added relevant documentation (doc comments with ///).
All existing and new tests are passing.
The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read [Handling breaking changes].

No, no existing tests failed, so this is not a breaking change.

fluttergithubbot · 2020-04-20T15:48:23Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

gildaswise · 2020-05-13T15:59:22Z

Just a heads-up, this is different from #58970, that one just adds more properties coming from theme.inputDecorationTheme instead of completely using it, as it should be. This one fixes the issue of a changed InputDecoration not working at all with the SearchDelegate, and makes it so we don't have to keep adding properties manually like that.

hawkinsjb1 · 2020-07-06T18:32:18Z

What's the status of this? The current SearchDelegate implementation seems to cherry-pick specific theme params as opposed to wrapping in a ThemeData like this fix does

gildaswise · 2020-07-06T18:34:09Z

@hawkinsjb1 Still waiting on something too, I believe it's still up-to-date with the latest delegate.

darrenaustin

@gildaswise, so sorry it has taken me a while to get to this. Thanks for your contribution.

It looks like this has been here long enough to get out of sync with the master branch, so this will need to be updated.

The change itself looks reasonable, but we will also need a test added that verifies that this works so that no one will break this in the future.

If you are no longer interested in working on this, just let us know and we can find someone to take it on. Thx.

gildaswise · 2020-09-10T15:48:53Z

@darrenaustin Starting to work on this again right now, thanks for looking into it!

Rebase branch

…meData instead of raw InputDecoration

gildaswise · 2020-09-10T19:11:03Z

@darrenaustin Just finished, had to change my approach to this. Before, it was meant to be a PR that fixed custom InputDecorationTheme usage when that's defined way back in MaterialApp's theme property, but that messed things up when you tried to just change something manually, or wanted to only customize a single screen.

I changed it to add the searchFieldDecoration property that should handle all InputDecorationTheme stuff and still manages to apply your default InputDecorationTheme if available.

I had to update two tests that relied on checking TextField's decoration property because since I changed it to only use the Theme version, they started to fail searching for properties that aren't there anymore. So now those tests and the new one check the Widget's ThemeData instead.

flutter-dashboard · 2020-09-30T19:18:04Z

This pull request executed golden file tests, but it has not been updated in a while (20+ days). Test results from Gold expire after as many days, so this pull request will need to be updated with a fresh commit in order to get results from Gold.For more guidance, visit Writing a golden file test for package:flutter.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

darrenaustin

Sorry it took a while to get to this. Thanks so much for the contribution. There are several PRs that are attempting to solve various parts of this issue, but yours seems the most robust. I have a few issues though.

First, there are a lot of unrelated style changes here that make it hard to see what the actual fix is that you are proposing. The Flutter framework uses a different style guide from dart. Can you please revert these style changes to make it easier to review your fix?

I have other code specific comments below. Thanks again.

packages/flutter/lib/src/material/search.dart

gildaswise · 2020-10-26T14:31:48Z

@gildaswise, thanks again for continuing to work on this PR. Apologies it has taken me a while to review your latest updates. It still looks like a fair amount of changes here that aren't related to just fixing the problem. I have noted them below.

There are also a couple of suggestions I have for the tests.

Otherwise this looks good. We have an internal user that is keen to get this fix, so I would like to expedite getting this merged. If you don't have the time or desire to continue with this, I can take it from here and build a new PR with what we need (giving you credit of course). Just let me know. Thanks again!

Finally removed all unrelated changes, so sorry about that. I checked the file diff and everything should be on point now. Just let me know about the last test comment I made and it should be fine now. Thanks for reviewing and I understand the internal user, haha.

gildaswise · 2020-10-26T16:22:01Z

I just fixed the merge conflict, but the two new tests from #67679 are not working. I tried just removing my changes to see if would go fine, but it didn't. It says that AppBar.backgroundColor is null, so it fails on both lines 728 and 753.

══╡ EXCEPTION CAUGHT BY FLUTTER TEST FRAMEWORK ╞════════════════════════════════════════════════════
The following TestFailure object was thrown running a test:
  Expected: Color:<Color(0xff212121)>
  Actual: <null>

I also just added a quick print('is appBar.backgroundColor null: ${appBar.backgroundColor}') check before the expect call and: is appBar.backgroundColor null: null was the return. Not really sure what's going on here and would appreciate help, @darrenaustin or @justinmc.

darrenaustin

Making good progress. Thanks. I still have a few requests below. The tests are breaking due to the removal of some settings on the AppBar. I have pointed them out below as well.

packages/flutter/lib/src/material/search.dart

darrenaustin

Looks good, and the tests are passing. However, I steered you the wrong way on putting those AppBar parameters back. We need to remove them, as you had it right the first time. Really sorry about that.

For the new tests that will break with them missing, we can adjust them to look at the underlying Material widget instead of the AppBar itself. I can't seem to put a comment on the code itself, but in the test code for 'text in search bar contrasts background (light mode)', you can change the appBar color check to:

    final Material appBarBackground = tester.widget<Material>(find.descendant(
      of: find.byType(AppBar),
      matching: find.byType(Material),
    ));
    expect(appBarBackground.color, Colors.white);

And the equivalent for the dark mode test.

Again, thanks for your patience and work here. I think it is really close.

packages/flutter/lib/src/material/search.dart

darrenaustin

Thanks for all the work on this @gildaswise!

gildaswise · 2020-10-27T17:36:40Z

Thanks for reviewing, @darrenaustin! Hope everyone benefits from this asap, too.

fluttergithubbot · 2020-10-27T19:02:02Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

gildaswise · 2020-10-27T19:04:48Z

@darrenaustin Let me know what exactly I need to change here, unfortunately the "Details" button on Google testing doesn't really help.

darrenaustin · 2020-10-27T19:21:00Z

@darrenaustin Let me know what exactly I need to change here, unfortunately the "Details" button on Google testing doesn't really help.

Yeah, it tripped an internal test. Looking at the results I don't think it is related to your change. I am trying to figure out what is going on and will get back to you and hopefully we can land this soon. Thx.

darrenaustin · 2020-10-27T21:10:07Z

It was an unrelated dependency issue with the tests. I marked it as passed on the internal side and just pushed to master. Thanks again for all the time and work on this one.

vasilich6107 · 2020-10-27T22:32:12Z

Congrats @gildaswise and @darrenaustin for not giving up and finishing this PR after 6 month!

…55209)" (#69241)

juliavi · 2021-02-23T01:28:20Z

Still not resolved in the latest version

intraector · 2021-02-28T08:44:33Z

Same issue

justinmc · 2021-04-02T20:13:58Z

@juliavi @intraector What Flutter version specifically are you seeing this problem on? Can you open a new issue with repro instructions?

Updated SearchDelegate to follow InputDecorationTheme

147071d

fluttergithubbot added f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. labels Apr 20, 2020

googlebot added the cla: yes label Apr 20, 2020

gildaswise changed the title ~~Updated SearchDelegate to follow InputDecorationTheme~~ Updated SearchDelegate to follow custom InputDecorationTheme Apr 20, 2020

HansMuller requested a review from darrenaustin April 24, 2020 18:51

Merge branch 'master' into gildaswise-search-delegate

14d44be

This was referenced May 8, 2020

SearchDelegate: appBarTheme method won't change the cursorColor. #52483

Closed

InputDecorationTheme override does not work in appBarTheme override in Search Box #56574

Closed

hawkinsjb1 mentioned this pull request Jul 22, 2020

unable to override theme of SearchDelegate #45498

Closed

markusaksli-nc linked an issue Jul 22, 2020 that may be closed by this pull request

unable to override theme of SearchDelegate #45498

Closed

charleshan mentioned this pull request Aug 1, 2020

SearchDelegate should respect InputDecoration theme override #19734

Closed

darrenaustin suggested changes Sep 10, 2020

View reviewed changes

gildaswise added 7 commits September 10, 2020 12:52

Merge pull request #1 from flutter/master

9bede20

Rebase branch

Added 'Custom inputDecorationTheme value' test

8ae6cb7

Re-modified search.dart, fixing branch

fa2e4ad

Added 'Custom inputDecorationTheme value' test

9f7fd4b

Still trying to rebase

55e387e

Reworked PR, added searchFieldDecoration and updated tests to use The…

736c913

…meData instead of raw InputDecoration

Removed leftover print statements

fbaeb24

gildaswise requested a review from darrenaustin September 10, 2020 19:07

darrenaustin suggested changes Oct 5, 2020

View reviewed changes

packages/flutter/lib/src/material/search.dart Outdated Show resolved Hide resolved

packages/flutter/lib/src/material/search.dart Outdated Show resolved Hide resolved

fix: fixed formatting issues, updated requested changes

76f78c2

Removed more unrelated changes due to auto format

eabe8c1

gildaswise requested a review from darrenaustin October 26, 2020 14:56

gildaswise added 2 commits October 26, 2020 13:10

Added changes from flutter#67679

7923ea8

Merged latest from upstream

6a9f0ab

darrenaustin suggested changes Oct 26, 2020

View reviewed changes

Comment changes, back with AppBar properties

85e5f9f

gildaswise requested a review from darrenaustin October 26, 2020 20:36

darrenaustin suggested changes Oct 27, 2020

View reviewed changes

packages/flutter/lib/src/material/search.dart Outdated Show resolved Hide resolved

Removed AppBar parameters, updated tests

f86150c

gildaswise requested a review from darrenaustin October 27, 2020 15:21

darrenaustin approved these changes Oct 27, 2020

View reviewed changes

darrenaustin added the waiting for tree to go green label Oct 27, 2020

fluttergithubbot removed the waiting for tree to go green label Oct 27, 2020

darrenaustin merged commit 48a9fc1 into flutter:master Oct 27, 2020

gildaswise deleted the gildaswise-search-delegate branch October 27, 2020 22:10

fluttergithubbot pushed a commit that referenced this pull request Oct 29, 2020

Revert "Updated SearchDelegate to follow custom InputDecorationTheme (#…

69d7637

…55209)" (#69241)

darrenaustin mentioned this pull request Nov 3, 2020

Reland "Updated SearchDelegate to follow custom InputDecorationTheme" #69653

Merged

pedromassangocode mentioned this pull request Jan 20, 2021

Update SearchDelegate's Textfield theme #66726

Closed

guidezpl mentioned this pull request Oct 29, 2021

☂️ Material Theme System Updates #91772

Open

42 tasks

Updated SearchDelegate to follow custom InputDecorationTheme #55209

Updated SearchDelegate to follow custom InputDecorationTheme #55209

Uh oh!

Conversation

gildaswise commented Apr 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Checklist

Breaking Change

Uh oh!

fluttergithubbot commented Apr 20, 2020

Uh oh!

gildaswise commented May 13, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hawkinsjb1 commented Jul 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gildaswise commented Jul 6, 2020

Uh oh!

darrenaustin left a comment

Choose a reason for hiding this comment

Uh oh!

gildaswise commented Sep 10, 2020

Uh oh!

gildaswise commented Sep 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

flutter-dashboard bot commented Sep 30, 2020

Uh oh!

darrenaustin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gildaswise commented Oct 26, 2020

Uh oh!

gildaswise commented Oct 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

darrenaustin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

darrenaustin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

darrenaustin left a comment

Choose a reason for hiding this comment

Uh oh!

gildaswise commented Oct 27, 2020

Uh oh!

fluttergithubbot commented Oct 27, 2020

Uh oh!

gildaswise commented Oct 27, 2020

Uh oh!

darrenaustin commented Oct 27, 2020

Uh oh!

darrenaustin commented Oct 27, 2020

Uh oh!

vasilich6107 commented Oct 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

juliavi commented Feb 23, 2021

Uh oh!

intraector commented Feb 28, 2021

Uh oh!

justinmc commented Apr 2, 2021

Uh oh!

Uh oh!

gildaswise commented Apr 20, 2020 •

edited

Loading

gildaswise commented May 13, 2020 •

edited

Loading

hawkinsjb1 commented Jul 6, 2020 •

edited

Loading

gildaswise commented Sep 10, 2020 •

edited

Loading

gildaswise commented Oct 26, 2020 •

edited

Loading

vasilich6107 commented Oct 27, 2020 •

edited

Loading