`WidgetState` mapping #146043

nate-thegrate · 2024-03-30T23:49:55Z

This pull request implements enhanced enum features for the new WidgetState enum, in order to improve the developer experience when creating and using WidgetStateProperty objects.

WidgetState now has a .matchesSet() method:

// identical to "states.contains(WidgetState.error)"
final bool hasError = WidgetState.error.isSatisfiedBy(states);

This addition allows for wide variety of WidgetStateProperty objects to be constructed in a simple manner.

// before
final style = MaterialStateTextStyle.resolveWith((states) {
  if (states.contains(MaterialState.error)) {
    return const TextStyle(color: Colors.red);
  } else if (states.contains(MaterialState.focused)) {
    return const TextStyle(color: Colors.blue);
  }
  return const TextStyle(color: Colors.black);
});


// after
const style = WidgetStateTextStyle.fromMap({
  WidgetState.error:   TextStyle(color: Colors.red),
  WidgetState.focused: TextStyle(color: Colors.blue),
  WidgetState.any:     TextStyle(color: Colors.black),
});

// before
final color = MaterialStateProperty.resolveWith((states) {
  if (states.contains(MaterialState.focused)) {
    return Colors.blue;
  } else if (!states.contains(MaterialState.disabled)) {
    return Colors.black;
  }
  return null;
});


// after
final color = WidgetStateProperty<Color?>.fromMap({
  WidgetState.focused:   Colors.blue,
  ~WidgetState.disabled: Colors.black,
});

// before
const activeStates = [MaterialState.selected, MaterialState.focused, MaterialState.scrolledUnder];

final color = MaterialStateColor.resolveWith((states) {
  if (activeStates.any(states.contains)) {
    if (states.contains(MaterialState.hovered) {
      return Colors.blueAccent;
    }
    return Colors.blue;
  }
  return Colors.black;
});


// after
final active = WidgetState.selected | WidgetState.focused | WidgetState.scrolledUnder;

final color = WidgetStateColor.fromMap({
  active & WidgetState.hovered: Colors.blueAccent,
  active:  Colors.blue,
  ~active: Colors.black,
});

(fixes #146042, and also fixes #143488)

cedvdb · 2024-04-01T11:04:09Z

imo WidgetState.isError(states) would be more intuitive than WidgetState.error(states)

nate-thegrate · 2024-04-01T15:43:23Z

@cedvdb this is a really good point.

~~In order to make the mapping work, I added a "call" method~~ there's no longer a call method, it is now .isSatisfiedBy() 🙂

Apologies for not making this change sooner!

MitchellGoodwin

Thank you for this PR! I think this is a great solution, that covers simple cases and complicated combinations well. I have some questions I'd like to talk about, but no complaints otherwise.

packages/flutter/lib/src/widgets/widget_state.dart

MitchellGoodwin

LGTM with one follow up on naming. Thanks again for this PR, it's a great addition.

packages/flutter/lib/src/widgets/widget_state.dart

MitchellGoodwin · 2024-05-10T20:41:35Z

The Google testing looks related. In one spot, there is a set of only a few WidgetStates.
Pseudo code it looks like this.

const certainStates = <WidgetState>{
   WidgetState.pressed,
   WidgetState.hovered,
}

It threw this error over this:
Error: Constant evaluation error: const certainStates = {

Context: The element 'WidgetState {}' conflicts with another existing element in the set.

'WidgetState' is from 'package:flutter/src/widgets/widget_state.dart'
WidgetState.focused,

Context: While analyzing: const interactiveStates = {

nate-thegrate · 2024-07-18T16:10:19Z

Third time's the charm! 🤞

Roll Flutter from 58068d8 to 7d5c1c0 (104 revisions) flutter/flutter@58068d8...7d5c1c0 2024-07-19 [email protected] Enhances intuitiveness of RawMagnifier's example (flutter/flutter#150308) 2024-07-19 [email protected] Roll pub packages (flutter/flutter#151992) 2024-07-19 [email protected] Add test for scrollbar.1.dart (flutter/flutter#151463) 2024-07-19 [email protected] Roll Flutter Engine from ea1e53a4e810 to 969fb7abc449 (3 revisions) (flutter/flutter#152018) 2024-07-19 [email protected] docimports for rendering library (flutter/flutter#151958) 2024-07-19 [email protected] Roll Flutter Engine from b65c93ea948e to ea1e53a4e810 (2 revisions) (flutter/flutter#152012) 2024-07-19 [email protected] painting: drop deprecated (exported) hashList and hashValues functions (flutter/flutter#151677) 2024-07-18 [email protected] Roll Flutter Engine from 766f7bed7185 to b65c93ea948e (2 revisions) (flutter/flutter#152004) 2024-07-18 [email protected] Update TESTOWNERS (flutter/flutter#151907) 2024-07-18 [email protected] chore: fix test name & add description of tests (flutter/flutter#151959) 2024-07-18 [email protected] Roll Flutter Engine from 564ded4c4742 to 766f7bed7185 (2 revisions) (flutter/flutter#151998) 2024-07-18 [email protected] Fix SelectionArea scrolling conflicts (flutter/flutter#151138) 2024-07-18 [email protected] Fix: BaseTapAndDragGestureRecognizer should reset drag state after losing gesture arena (flutter/flutter#151989) 2024-07-18 [email protected] Roll pub packages (flutter/flutter#151975) 2024-07-18 [email protected] Roll Flutter Engine from 8bcf638eb893 to 564ded4c4742 (2 revisions) (flutter/flutter#151986) 2024-07-18 [email protected] Fix WidgetStateTextStyle's doc (flutter/flutter#151935) 2024-07-18 [email protected] Roll Flutter Engine from d58ba74250ce to 8bcf638eb893 (2 revisions) (flutter/flutter#151977) 2024-07-18 [email protected] Adds 3.22.3 changelog (flutter/flutter#151974) 2024-07-18 [email protected] Roll Packages from d03b1b4 to c7f0526 (8 revisions) (flutter/flutter#151971) 2024-07-18 [email protected] `WidgetState` mapping (flutter/flutter#146043) 2024-07-18 [email protected] Fix AppBar doc to keep diagram next to its description (flutter/flutter#151937) 2024-07-18 [email protected] Small fixes to Image docs: NNBD, and add a cross-reference (flutter/flutter#151938) 2024-07-18 [email protected] Roll Flutter Engine from b043fe447bb3 to d58ba74250ce (1 revision) (flutter/flutter#151964) 2024-07-18 [email protected] Roll pub packages (flutter/flutter#151946) 2024-07-18 [email protected] Roll pub packages (flutter/flutter#151904) 2024-07-18 [email protected] Roll Flutter Engine from e3abca2d8105 to b043fe447bb3 (1 revision) (flutter/flutter#151942) 2024-07-18 [email protected] Roll Flutter Engine from 8073523b4623 to e3abca2d8105 (1 revision) (flutter/flutter#151936) 2024-07-18 [email protected] Roll Flutter Engine from dfe22e3acc19 to 8073523b4623 (1 revision) (flutter/flutter#151934) 2024-07-18 [email protected] Roll Flutter Engine from 184c3f0de6b3 to dfe22e3acc19 (1 revision) (flutter/flutter#151930) 2024-07-18 [email protected] Roll Flutter Engine from 00f0f6b74da7 to 184c3f0de6b3 (1 revision) (flutter/flutter#151928) 2024-07-18 [email protected] Roll Flutter Engine from d194a2f0e5da to 00f0f6b74da7 (1 revision) (flutter/flutter#151927) 2024-07-18 [email protected] Roll Flutter Engine from a5a93bb80bd1 to d194a2f0e5da (3 revisions) (flutter/flutter#151925) 2024-07-17 [email protected] Roll Flutter Engine from e9dc62074c2b to a5a93bb80bd1 (1 revision) (flutter/flutter#151918) 2024-07-17 [email protected] [web] use the new backlog Github project in triage links (flutter/flutter#151920) 2024-07-17 [email protected] Update Flutter-Web-Triage.md (flutter/flutter#151607) 2024-07-17 [email protected] Reland fix InputDecorator hint default text style on M3 (flutter/flutter#150835) 2024-07-17 [email protected] Roll Flutter Engine from 39ee1a549581 to e9dc62074c2b (3 revisions) (flutter/flutter#151915) 2024-07-17 [email protected] Constrain `CupertinoContextMenu` animation to safe area (flutter/flutter#151860) 2024-07-17 [email protected] Create `CarouselView` widget - Part 2 (flutter/flutter#149775) 2024-07-17 [email protected] Roll Flutter Engine from 45b722b661f0 to 39ee1a549581 (3 revisions) (flutter/flutter#151905) 2024-07-17 [email protected] docs: Fix typo in data driven fixes test folder section (flutter/flutter#151836) 2024-07-17 [email protected] Stop running flaky mac tests in presubmit (flutter/flutter#151870) 2024-07-17 [email protected] Roll Flutter Engine from 7e2579634027 to 45b722b661f0 (1 revision) (flutter/flutter#151895) 2024-07-17 [email protected] fix(Flutter Web App): fixes html lang typo (flutter/flutter#151866) 2024-07-17 [email protected] Delete `docs/engine` directory (flutter/flutter#151616) 2024-07-17 [email protected] Make `CupertinoSlidingSegmentedControl` type parameter non-null (flutter/flutter#151803) ...

This pull request implements [enhanced enum](https://dart.dev/language/enums#declaring-enhanced-enums) features for the new `WidgetState` enum, in order to improve the developer experience when creating and using `WidgetStateProperty` objects. `WidgetState` now has a `.matchesSet()` method: ```dart // identical to "states.contains(WidgetState.error)" final bool hasError = WidgetState.error.isSatisfiedBy(states); ``` This addition allows for wide variety of `WidgetStateProperty` objects to be constructed in a simple manner. <br><br> ```dart // before final style = MaterialStateTextStyle.resolveWith((states) { if (states.contains(MaterialState.error)) { return TextStyle(color: Colors.red); } else if (states.contains(MaterialState.focused)) { return TextStyle(color: Colors.blue); } return TextStyle(color: Colors.black); }); // after final style = WidgetStateTextStyle.fromMap({ WidgetState.error: TextStyle(color: Colors.red), WidgetState.focused: TextStyle(color: Colors.blue), WidgetState.any: TextStyle(color: Colors.black), // "any" is a static const member, not an enum value }); ``` ```dart // before final color = MaterialStateProperty.resolveWith((states) { if (states.contains(MaterialState.focused)) { return Colors.blue; } else if (!states.contains(MaterialState.disabled)) { return Colors.black; } return null; }); // after final color = WidgetStateProperty<Color?>.fromMap({ WidgetState.focused: Colors.blue, ~WidgetState.disabled: Colors.black, }); ``` ```dart // before const activeStates = [MaterialState.selected, MaterialState.focused, MaterialState.scrolledUnder]; final color = MaterialStateColor.resolveWith((states) { if (activeStates.any(states.contains)) { if (states.contains(MaterialState.hovered) { return Colors.blueAccent; } return Colors.blue; } return Colors.black; }); // after final active = WidgetState.selected | WidgetState.focused | WidgetState.scrolledUnder; final color = WidgetStateColor.fromMap({ active & WidgetState.hovered: Colors.blueAccent, active: Colors.blue, ~active: Colors.black, }); ``` <br> (fixes flutter#146042, and also fixes flutter#143488)

goderbauer requested a review from MitchellGoodwin April 9, 2024 22:06

MitchellGoodwin reviewed Apr 11, 2024

View reviewed changes

goderbauer requested a review from MitchellGoodwin May 7, 2024 22:01

MitchellGoodwin approved these changes May 9, 2024

View reviewed changes

packages/flutter/lib/src/widgets/widget_state.dart Outdated Show resolved Hide resolved

nate-thegrate added the autosubmit Merge PR when tree becomes green via auto submit App label May 9, 2024

Hixie reviewed May 9, 2024

View reviewed changes

packages/flutter/lib/src/widgets/widget_state.dart Outdated Show resolved Hide resolved

Hixie reviewed May 9, 2024

View reviewed changes

packages/flutter/lib/src/widgets/widget_state.dart Outdated Show resolved Hide resolved

nate-thegrate added autosubmit Merge PR when tree becomes green via auto submit App and removed autosubmit Merge PR when tree becomes green via auto submit App labels May 9, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 10, 2024

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

nate-thegrate force-pushed the widget-state-mapping branch from a1bb9b5 to da86ed7 Compare May 23, 2024 19:37

nate-thegrate mentioned this pull request Jun 19, 2024

SplashFactory in the widgets library #149963

Closed

nate-thegrate force-pushed the widget-state-mapping branch from cb6c862 to e8b87ac Compare June 21, 2024 01:48

This comment was marked as resolved.

Sign in to view

github-actions bot added the a: text input Entering text in a text field or keyboard related problems label Jun 21, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jul 18, 2024

nate-thegrate added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 18, 2024

auto-submit bot merged commit db80f4e into flutter:master Jul 18, 2024

engine-flutter-autoroll mentioned this pull request Jul 18, 2024

Roll Flutter from 58068d8ea4ec to db80f4e71380 (85 revisions) flutter/packages#7165

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2024

db80f4e WidgetState mapping (flutter/flutter#146043)

d70ca99

engine-flutter-autoroll mentioned this pull request Jul 18, 2024

Roll Flutter from 58068d8ea4ec to 9d76e120d015 (86 revisions) flutter/packages#7166

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2024

db80f4e WidgetState mapping (flutter/flutter#146043)

b9d2390

engine-flutter-autoroll mentioned this pull request Jul 18, 2024

Roll Flutter from 58068d8ea4ec to 504023276386 (87 revisions) flutter/packages#7168

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2024

db80f4e WidgetState mapping (flutter/flutter#146043)

43fa2ec

engine-flutter-autoroll mentioned this pull request Jul 18, 2024

Roll Flutter from 58068d8ea4ec to b5030df77ccb (88 revisions) flutter/packages#7169

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 18, 2024

db80f4e WidgetState mapping (flutter/flutter#146043)

3526d07

nate-thegrate deleted the widget-state-mapping branch July 18, 2024 23:04

engine-flutter-autoroll mentioned this pull request Jul 19, 2024

Manual roll Flutter from 58068d8ea4ec to 73321aa95009 (97 revisions) flutter/packages#7173

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 19, 2024

db80f4e WidgetState mapping (flutter/flutter#146043)

0207f43

engine-flutter-autoroll mentioned this pull request Jul 19, 2024

Roll Flutter from 58068d8ea4ec to 7d5c1c04fb56 (104 revisions) flutter/packages#7176

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 19, 2024

db80f4e WidgetState mapping (flutter/flutter#146043)

924faa4

engine-flutter-autoroll mentioned this pull request Jul 19, 2024

Roll Flutter from 58068d8ea4ec to 7d5c1c04fb56 (104 revisions) flutter/packages#7177

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 19, 2024

db80f4e WidgetState mapping (flutter/flutter#146043)

8b1d89d

engine-flutter-autoroll mentioned this pull request Jul 19, 2024

Roll Flutter from 58068d8ea4ec to 49a315284d11 (105 revisions) flutter/packages#7178

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 19, 2024

db80f4e WidgetState mapping (flutter/flutter#146043)

32d8cc0

engine-flutter-autoroll mentioned this pull request Jul 19, 2024

Roll Flutter from 58068d8ea4ec to 20242d0c4142 (107 revisions) flutter/packages#7179

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 19, 2024

db80f4e WidgetState mapping (flutter/flutter#146043)

06007df

Piinks mentioned this pull request Jul 26, 2024

Flutter Framework Team: Notable Commits #121415

Closed

victorsanni mentioned this pull request Aug 1, 2024

Use .fromMap() constructors in example code #152535

Merged

justinmc mentioned this pull request Aug 27, 2024

Defining updating theme causes lot of rebuilds #89127

Closed

nate-thegrate mentioned this pull request Oct 14, 2024

Notable Mishaps #156720

Closed

WidgetState mapping #146043

WidgetState mapping #146043

Uh oh!

Conversation

nate-thegrate commented Mar 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cedvdb commented Apr 1, 2024

Uh oh!

nate-thegrate commented Apr 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MitchellGoodwin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MitchellGoodwin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

MitchellGoodwin commented May 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

nate-thegrate commented Jul 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

`WidgetState` mapping #146043

`WidgetState` mapping #146043

nate-thegrate commented Mar 30, 2024 •

edited

Loading

nate-thegrate commented Apr 1, 2024 •

edited

Loading

MitchellGoodwin commented May 10, 2024 •

edited

Loading