Add useInheritedMediaQuery removal breaking change entry and migration guide
#13916
+60
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| title: Remove useInheritedMediaQuery | ||
| description: >- | ||
| The `useInheritedMediaQuery` property has been removed from the Flutter framework. | ||
| --- | ||
|
|
||
| {% render "docs/breaking-changes.md" %} | ||
|
|
||
| ## Summary | ||
|
|
||
| The `useInheritedMediaQuery` properties in `WidgetsApp`, `MaterialApp`, and `CupertinoApp` were removed because these widget never introduced their own MediaQuery, the View widget takes care of that. | ||
|
|
||
| ## Context | ||
|
|
||
| Historically, Flutter used `useInheritedMediaQuery` to determine whether a `WidgetsApp`, `MaterialApp`, or `CupertinoApp` should inherit the `MediaQuery` from its parent. This became redundant when `MediaQuery` inheritance became the default behavior. | ||
|
|
||
| ## Migration guide | ||
|
|
||
| If your code previously used `useInheritedMediaQuery`, you can migrate it by deleting any usage of the property. | ||
|
|
||
| ```dart diff | ||
| - useInheritedMediaQuery: true, | ||
| ``` | ||
|
|
||
| ```dart diff | ||
| - useInheritedMediaQuery: false, | ||
| ``` | ||
|
|
||
| :::important | ||
| This migration isn't supported by `dart fix`. | ||
| ::: | ||
|
|
||
| ## Timeline | ||
|
|
||
| Landed in version: TBD<br> | ||
| In stable release: TBD | ||
|
Comment on lines
+35
to
+36
Contributor
There was a problem hiding this comment. Don't forget these when ready.
Member
Author
There was a problem hiding this comment. you mean when the new stable is cut right ? |
||
|
|
||
| ## References | ||
|
|
||
| API documentation: | ||
|
|
||
| * [`WidgetsApp`][] | ||
| * [`MaterialApp`][] | ||
| * [`CupertinoApp`][] | ||
|
|
||
|
|
||
| Relevant PRs: | ||
|
|
||
| * [PR 193146][] | ||
| * [PR 12970][] | ||
| * [PR 12969][] | ||
|
|
||
| [`WidgetsApp`]: {{site.api}}/flutter/widgets/WidgetsApp-class.html | ||
| [`MaterialApp`]: {{site.pub}}/documentation/material_ui/latest/material_ui/MaterialApp-class.html | ||
| [`CupertinoApp`]: {{site.pub}}/documentation/cupertino_ui/latest/cupertino_ui/CupertinoApp-class.html | ||
|
sfshaza2 marked this conversation as resolved.
|
||
| [PR 193146]: {{site.repo.flutter}}/pull/193146 | ||
| [PR 12970]: {{site.repo.packages}}/pull/12970 | ||
| [PR 12969]: {{site.repo.packages}}/pull/12969 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it could be by using
removeParameterright? What do you think about including a dart fix for this?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure how create/edit dart fixes tbh