MediaQueryModifier.removeViewInsets constructor

MediaQueryModifier.removeViewInsets({ Key? key, Widget? child, required BuildContext context, bool removeLeft = false, bool removeTop = false, bool removeRight = false, bool removeBottom = false, })

Creates a new MediaQuery that inherits from the ambient MediaQuery from the given context, but removes the specified view insets.

This should be inserted into the widget tree when the MediaQuery view insets are consumed by a widget in such a way that the view insets are no longer exposed to the widget's descendants or siblings.

The context argument is required, must not be null, and must have a MediaQuery in scope.

The removeLeft, removeTop, removeRight, and removeBottom arguments must not be null. If all four are false (the default) then the returned MediaQuery reuses the ambient MediaQueryData unmodified, which is not particularly useful.

The child argument is required and must not be null.

See also:

• MediaQueryData.viewInsets, the affected property of the MediaQueryData.
• removePadding, the same thing but for MediaQueryData.padding.
• removeViewPadding, the same thing but for MediaQueryData.viewPadding.

Implementation

factory MediaQueryModifier.removeViewInsets({
  Key? key,
  Widget? child,
  required BuildContext context,
  bool removeLeft = false,
  bool removeTop = false,
  bool removeRight = false,
  bool removeBottom = false,
}) {
  return MediaQueryModifier(
    key: key,
    data: MediaQuery.of(context).removeViewInsets(
      removeLeft: removeLeft,
      removeTop: removeTop,
      removeRight: removeRight,
      removeBottom: removeBottom,
    ),
    child: child,
  );
}