firka/flutter
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Super tiny MediaQuery doc update (#127904)

Browse Source 
Just now I see some good news: https://www.reddit.com/r/FlutterDev/comments/13vo5a2/the_most_important_flutter_310_feature_that/ (ignore the title though...). It was a performance problem in the old days, so it was great that the problem disappears. However, it seems that the doc is not updated yet, so everyone reading MediaQuery page will still use the old way. Thus I create this super-tiny PR :)
This commit is contained in:
fzyzcjy
2023-06-08 01:04:03 +08:00
committed by GitHub
parent 2830f0734d
commit 8a5c22e282
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
packages/flutter/lib/src/widgets/media_query.dart
View File

@@ -756,16 +756,24 @@ class MediaQueryData {
/// Establishes a subtree in which media queries resolve to the given data.
///
/// For example, to learn the size of the current media (e.g., the window
/// containing your app), you can read the [MediaQueryData.size] property from
/// the [MediaQueryData] returned by [MediaQuery.of]:
/// `MediaQuery.of(context).size`.
/// containing your app), you can use [MediaQuery.sizeOf]:
/// `MediaQuery.sizeOf(context)`.
///
/// Querying the current media using [MediaQuery.of] will cause your widget to
/// rebuild automatically whenever the [MediaQueryData] changes (e.g., if the
/// user rotates their device).
/// Querying the current media using specific methods (for example,
/// [MediaQuery.sizeOf] and [MediaQuery.paddingOf]) will cause your widget to
/// rebuild automatically whenever the property you query changes.
///
/// If no [MediaQuery] is in scope then the [MediaQuery.of] method will throw an
/// exception. Alternatively, [MediaQuery.maybeOf] may be used, which returns
/// On the other hand, querying using [MediaQuery.of] will cause your widget to
/// rebuild automatically whenever any field of the [MediaQueryData] changes
/// (e.g., if the user rotates their device). Therefore, if you are only
/// concerned with one or a few fields of [MediaQueryData], prefer using
/// the specific methods (for example: [MediaQuery.sizeOf] and
/// [MediaQuery.paddingOf]).
///
/// If no [MediaQuery] is in scope then the series of methods like
/// [MediaQuery.of] and [MediaQuery.sizeOf] will throw an exception.
/// Alternatively, the "maybe-" variant methods (such as [MediaQuery.maybeOf]
/// and [MediaQuery.maybeSizeOf]) can be used, which returns
/// null instead of throwing if no [MediaQuery] is in scope.
///
/// {@youtube 560 315 https://www.youtube.com/watch?v=A3WrA4zAaPw}