MediaQuery class
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
.
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).
If no MediaQuery is in scope then the MediaQuery.of method will throw an exception. Alternatively, MediaQuery.maybeOf may be used, which returns null instead of throwing if no MediaQuery is in scope.
See also:
- WidgetsApp and MaterialApp, which introduce a MediaQuery and keep it up to date with the current screen metrics as they change.
- MediaQueryData, the data structure that represents the metrics.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- ProxyWidget
- InheritedWidget
- InheritedModel<
_MediaQueryAspect> - MediaQuery
Constructors
- MediaQuery({Key? key, required MediaQueryData data, required Widget child})
-
Creates a widget that provides MediaQueryData to its descendants.
const
- MediaQuery.removePadding({Key? key, required BuildContext context, bool removeLeft = false, bool removeTop = false, bool removeRight = false, bool removeBottom = false, required Widget child})
-
Creates a new MediaQuery that inherits from the ambient MediaQuery
from the given context, but removes the specified padding.
factory
- MediaQuery.removeViewInsets({Key? key, required BuildContext context, bool removeLeft = false, bool removeTop = false, bool removeRight = false, bool removeBottom = false, required Widget child})
-
Creates a new MediaQuery that inherits from the ambient MediaQuery
from the given context, but removes the specified view insets.
factory
- MediaQuery.removeViewPadding({Key? key, required BuildContext context, bool removeLeft = false, bool removeTop = false, bool removeRight = false, bool removeBottom = false, required Widget child})
-
Creates a new MediaQuery that inherits from the ambient MediaQuery
from the given context, but removes the specified view padding.
factory
Properties
- child → Widget
-
The widget below this widget in the tree.
finalinherited
- data → MediaQueryData
-
Contains information about the current media.
final
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
Methods
-
createElement(
) → InheritedModelElement< _MediaQueryAspect> -
Inflates this configuration to a concrete instance.
inherited
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of
DiagnosticsNode
objects describing this node's children.inherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
override
-
isSupportedAspect(
Object aspect) → bool -
Returns true if this model supports the given
aspect
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
-
updateShouldNotify(
covariant MediaQuery oldWidget) → bool -
Whether the framework should notify widgets that inherit from this widget.
override
-
updateShouldNotifyDependent(
covariant MediaQuery oldWidget, Set< Object> dependencies) → bool -
Return true if the changes between this model and
oldWidget
match any of thedependencies
.override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
- Returns accessibleNavigationOf for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
alwaysUse24HourFormatOf(
BuildContext context) → bool - Returns alwaysUse for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
boldTextOf(
BuildContext context) → bool - Returns the boldText accessibility setting for the nearest MediaQuery ancestor or false, if no such ancestor exists.
-
boldTextOverride(
BuildContext context) → bool - Returns the boldText accessibility setting for the nearest MediaQuery ancestor or false, if no such ancestor exists.
-
devicePixelRatioOf(
BuildContext context) → double - Returns devicePixelRatio for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
disableAnimationsOf(
BuildContext context) → bool - Returns disableAnimations for the nearest MediaQuery ancestor or Brightness.light, if no such ancestor exists.
-
displayFeaturesOf(
BuildContext context) → List< DisplayFeature> - Returns displayFeatures for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
fromView(
{Key? key, required FlutterView view, required Widget child}) → Widget -
Wraps the
child
in a MediaQuery which is built using data from the providedview
. -
fromWindow(
{Key? key, required Widget child}) → Widget - Deprecated. Use MediaQuery.fromView instead.
-
gestureSettingsOf(
BuildContext context) → DeviceGestureSettings - Returns gestureSettings for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
highContrastOf(
BuildContext context) → bool - Returns highContrast for the nearest MediaQuery ancestor or false, if no such ancestor exists.
-
invertColorsOf(
BuildContext context) → bool - Returns invertColorsOf for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
- Returns accessibleNavigation for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeAlwaysUse24HourFormatOf(
BuildContext context) → bool? - Returns alwaysUse24HourFormat for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeBoldTextOf(
BuildContext context) → bool? - Returns the boldText accessibility setting for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeDevicePixelRatioOf(
BuildContext context) → double? - Returns devicePixelRatio for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeDisableAnimationsOf(
BuildContext context) → bool? - Returns disableAnimations for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeDisplayFeaturesOf(
BuildContext context) → List< DisplayFeature> ? - Returns displayFeatures for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeGestureSettingsOf(
BuildContext context) → DeviceGestureSettings? - Returns gestureSettings for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeHighContrastOf(
BuildContext context) → bool? - Returns highContrast for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeInvertColorsOf(
BuildContext context) → bool? - Returns invertColors for the nearest MediaQuery ancestor or null, if no such ancestor exists.
- Returns navigationMode for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeOf(
BuildContext context) → MediaQueryData? - The data from the closest instance of this class that encloses the given context, if any.
-
maybeOrientationOf(
BuildContext context) → Orientation? - Returns orientation for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybePaddingOf(
BuildContext context) → EdgeInsets? - Returns viewInsets for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybePlatformBrightnessOf(
BuildContext context) → Brightness? - Returns platformBrightness for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeSizeOf(
BuildContext context) → Size? - Returns size for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeSystemGestureInsetsOf(
BuildContext context) → EdgeInsets? - Returns systemGestureInsets for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeTextScaleFactorOf(
BuildContext context) → double? - Returns textScaleFactor for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeViewInsetsOf(
BuildContext context) → EdgeInsets? - Returns viewInsets for the nearest MediaQuery ancestor or null, if no such ancestor exists.
-
maybeViewPaddingOf(
BuildContext context) → EdgeInsets? - Returns viewPadding for the nearest MediaQuery ancestor or null, if no such ancestor exists.
- Returns navigationMode for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
of(
BuildContext context) → MediaQueryData - The data from the closest instance of this class that encloses the given context.
-
orientationOf(
BuildContext context) → Orientation - Returns orientation for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
paddingOf(
BuildContext context) → EdgeInsets - Returns padding for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
platformBrightnessOf(
BuildContext context) → Brightness - Returns platformBrightness for the nearest MediaQuery ancestor or Brightness.light, if no such ancestor exists.
-
sizeOf(
BuildContext context) → Size - Returns size for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
systemGestureInsetsOf(
BuildContext context) → EdgeInsets - Returns systemGestureInsets for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
textScaleFactorOf(
BuildContext context) → double - Returns textScaleFactor for the nearest MediaQuery ancestor or 1.0, if no such ancestor exists.
-
viewInsetsOf(
BuildContext context) → EdgeInsets - Returns viewInsets for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.
-
viewPaddingOf(
BuildContext context) → EdgeInsets - Returns viewPadding for the nearest MediaQuery ancestor or throws an exception, if no such ancestor exists.