Skip to content

Super tiny MediaQuery doc update #127904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 7, 2023
Merged

Super tiny MediaQuery doc update #127904

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0858d63
Update media_query.dart
fzyzcjy May 31, 2023
28c769d
improve
fzyzcjy Jun 2, 2023
dfc5992
bump ci
fzyzcjy Jun 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions packages/flutter/lib/src/widgets/media_query.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down