MaterialState migration guide by MitchellGoodwin · Pull Request #10194 · flutter/website

MitchellGoodwin · 2024-02-22T20:35:21Z

Adds a migration guide guide for MaterialState logic being marked deprecated by flutter/pull/142151

Presubmit checklist

This PR doesn’t contain automatically generated corrections (Grammarly or similar).
This PR follows the Google Developer Documentation Style Guidelines — for example, it doesn’t use i.e. or e.g., and it avoids I and we (first person).
This PR uses semantic line breaks of 80 characters or fewer.

flutter-website-bot · 2024-02-22T20:44:23Z

Visit the preview URL for this PR (updated for commit 8f9b821):

https://flutter-docs-prod--pr10194-material-state-migration-0x5o39j4.web.app

sfshaza2

A few minor edits. This feature sounds great. Thanks, @MitchellGoodwin!

sfshaza2 · 2024-02-22T21:04:31Z

src/release/breaking-changes/material-state.md

+
+## Summary
+
+`MaterialState`, and its related APIs have been moved out


Suggested change

`MaterialState`, and its related APIs have been moved out

`MaterialState`, and its related APIs, have been moved out

sfshaza2 · 2024-02-22T21:05:00Z

src/release/breaking-changes/material-state.md

+
+## Background
+
+`MaterialState` provided logic for handeling multiple different


Suggested change

`MaterialState` provided logic for handeling multiple different

Previously, `MaterialState` provided logic for handling multiple different

sfshaza2 · 2024-02-22T21:05:45Z

src/release/breaking-changes/material-state.md

+`MaterialState` provided logic for handeling multiple different
+states a widget could have, like "hovered", "focused", and
+"disabled". Because this functionality could be useful outside
+of the Material library, namely the base Widgets layer and


Suggested change

of the Material library, namely the base Widgets layer and

of the Material library, namely for the base Widgets layer and

sfshaza2 · 2024-02-22T21:06:03Z

src/release/breaking-changes/material-state.md

+of the Material library, namely the base Widgets layer and
+Cupertino, it was decided to move it outside of Material. As
+part of the move, and to avoid future confusion, the different
+MaterialState classes have been renamed to `WidgetState`. The


Suggested change

MaterialState classes have been renamed to `WidgetState`. The

`MaterialState` classes have been renamed to `WidgetState`. The

sfshaza2 · 2024-02-22T21:08:51Z

src/release/breaking-changes/material-state.md

+| MaterialState | WidgetState |
+| MaterialStatePropertyResolver | WidgetStatePropertyResolver |
+| MaterialStateColor | WidgetStateColor |
+| MaterialStateMouseCursor | WidgetStateColorMouseCursor |
+| MaterialStateBorderSide | WidgetStateBorderSide |
+| MaterialStateOutlinedBorder | WidgetStateOutlinedBorder |
+| MaterialStateTextStyle | WidgetStateTextStyle |
+| MaterialStateProperty | WidgetStateProperty |
+| MaterialStatePropertyAll | WidgetStatePropertyAll |
+| MaterialStatesController | WidgetStatesController |
+| MaterialStateMixin | WidgetStateMixin |


sfshaza2 · 2024-02-22T21:09:30Z

src/release/breaking-changes/material-state.md

+Material library with no `WidgetState` equivilant, as
+they are Material design specific.


Suggested change

Material library with no `WidgetState` equivilant, as

they are Material design specific.

Material library with no `WidgetState` equivalent, as

they are specific to Material design.

sfshaza2 · 2024-02-22T21:10:58Z

src/release/breaking-changes/material-state.md

+
+## Timeline
+
+Landed in version: xxx<br>


@MitchellGoodwin, do you have the info on which main or beta release has this change? Put that here.

It's not landed yet, we are trying to make sure our communication is ready to go before landing it. Should I put what release it's likely to be in for now? Or leave it as a placeholder.

Leave it for now, but once you know, we should update the page. thx!

goderbauer

LGTM

goderbauer · 2024-02-22T22:15:01Z

src/release/breaking-changes/material-state.md

+
+Previously, `MaterialState` provided logic for handling multiple different
+states a widget could have, like "hovered", "focused", and
+"disabled". Because this functionality could be useful outside


could be useful -> is useful?

goderbauer · 2024-02-22T22:16:05Z

src/release/breaking-changes/material-state.md

+    final MaterialPropertyResolver<MouseCursor?> resolveCallback;
+
+    @override
+    MouseCursor resolve(Set<MaterialState> states) => resolveCallback(states) ?? MouseCursor.uncontrolled;


nit here and below: I think usually we indent by only two spaces.

goderbauer · 2024-02-22T22:17:56Z

src/release/breaking-changes/material-state.md

+    MouseCursor resolve(Set<MaterialState> states) => resolveCallback(states) ?? MouseCursor.uncontrolled;
+}
+
+MaterialStateBorderSide? get side;


This top-level getter without a body looks a little strange. Is that even legal in dart? Maybe just have it return null?

goderbauer · 2024-02-22T22:18:16Z

src/release/breaking-changes/material-state.md

+
+Code after migration:
+
+```dart


Same comments about this sample

sfshaza2 · 2024-03-12T18:24:32Z

Have we lost you, @MitchellGoodwin?

MitchellGoodwin · 2024-03-12T18:32:18Z

Apologies, this change ended up causing a lot of discussion. I'll make updates to this.

MitchellGoodwin · 2024-04-03T20:57:18Z

Ready for review

goderbauer

LGTM

goderbauer · 2024-04-03T21:17:43Z

src/release/breaking-changes/material-state.md

+---
+title: Rename MaterialState to WidgetState
+description: >-
+  MaterialState and it's related APIs have been moved


Suggested change

MaterialState and it's related APIs have been moved

MaterialState and its related APIs have been moved

goderbauer · 2024-04-03T21:18:17Z

src/release/breaking-changes/material-state.md

+states a widget could have, like "hovered", "focused", and
+"disabled". Because this functionality is useful outside of the
+Material library, namely for the base Widgets layer and Cupertino,
+it was decided to move it outside of Material. Aspart of the move, and to


Suggested change

it was decided to move it outside of Material. Aspart of the move, and to

it was decided to move it outside of Material. As part of the move, and to

sfshaza2

lgtm. Thx, @MitchellGoodwin!

Adds a migration guide guide for MaterialState logic being marked deprecated by [flutter/pull/142151](flutter/flutter#142151) ## Presubmit checklist - [x] This PR doesn’t contain automatically generated corrections (Grammarly or similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer.

MitchellGoodwin mentioned this pull request Feb 22, 2024

Widget state properties flutter/flutter#142151

Merged

8 tasks

sfshaza2 reviewed Feb 22, 2024

View reviewed changes

goderbauer reviewed Feb 22, 2024

View reviewed changes

atsansone added the review.await-update Awaiting Updates after Edits label Feb 22, 2024

atsansone assigned MitchellGoodwin Feb 22, 2024

MitchellGoodwin force-pushed the material-state-migration branch from f316062 to d11cfc0 Compare March 19, 2024 21:08

MitchellGoodwin marked this pull request as ready for review March 22, 2024 20:25

MitchellGoodwin requested review from MaryaBelanger, atsansone, domesticmouse and parlough as code owners March 22, 2024 20:25

MitchellGoodwin added 4 commits April 3, 2024 13:28

MaterialState migration guide

e8b7242

Grammar fixes

23e6851

Updates

561acc4

Update version

98b0757

MitchellGoodwin force-pushed the material-state-migration branch from df33ecb to 98b0757 Compare April 3, 2024 20:28

MitchellGoodwin requested review from goderbauer and sfshaza2 April 3, 2024 20:57

goderbauer reviewed Apr 3, 2024

View reviewed changes

Typo fixes

8f9b821

parlough added review.copy Awaiting Copy Review and removed review.await-update Awaiting Updates after Edits labels Apr 4, 2024

parlough assigned sfshaza2 and unassigned MitchellGoodwin Apr 4, 2024

sfshaza2 approved these changes Apr 4, 2024

View reviewed changes

sfshaza2 removed the review.copy Awaiting Copy Review label Apr 4, 2024

sfshaza2 merged commit 558e194 into flutter:main Apr 4, 2024


		## Summary

		`MaterialState`, and its related APIs have been moved out

	`MaterialState`, and its related APIs have been moved out
	`MaterialState`, and its related APIs, have been moved out


		## Background

		`MaterialState` provided logic for handeling multiple different

	`MaterialState` provided logic for handeling multiple different
	Previously, `MaterialState` provided logic for handling multiple different

	of the Material library, namely the base Widgets layer and
	of the Material library, namely for the base Widgets layer and

	MaterialState classes have been renamed to `WidgetState`. The
	`MaterialState` classes have been renamed to `WidgetState`. The

		Material library with no `WidgetState` equivilant, as
		they are Material design specific.

	MaterialState and it's related APIs have been moved
	MaterialState and its related APIs have been moved

	it was decided to move it outside of Material. Aspart of the move, and to
	it was decided to move it outside of Material. As part of the move, and to


		Code after migration:

		```dart

Conversation

MitchellGoodwin commented Feb 22, 2024

Presubmit checklist

Uh oh!

flutter-website-bot commented Feb 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfshaza2 Feb 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

goderbauer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfshaza2 commented Mar 12, 2024

Uh oh!

MitchellGoodwin commented Mar 12, 2024

Uh oh!

MitchellGoodwin commented Apr 3, 2024

Uh oh!

goderbauer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

flutter-website-bot commented Feb 22, 2024 •

edited

Loading

sfshaza2 Feb 22, 2024 •

edited

Loading