SafeArea class

A widget that insets its child with sufficient padding to avoid intrusions by the operating system.

When a minimum padding is specified, the greater of the minimum padding or the safe area padding will be applied.

This example shows how SafeArea can apply padding within a mobile device's screen to make the relevant content completely visible.

To create a local project with this code sample, run:
flutter create --sample=widgets.SafeArea.1 mysample

This example creates a blue box containing text that is sufficiently padded to avoid intrusions by the operating system.

SafeArea(
  child: Container(
    constraints: const BoxConstraints.expand(),
    alignment: Alignment.center,
    color: Colors.blue,
    child: const Text('Hello, World!'),
  ),
)

MediaQuery impact

The padding on the MediaQuery for the child will be suitably adjusted to zero out any sides that were avoided by this widget.

Constructors

SafeArea({Key? key, bool left = true, bool top = true, bool right = true, bool bottom = true, EdgeInsets minimum = EdgeInsets.zero, bool maintainBottomViewPadding = false, required Widget child}): Creates a widget that avoids operating system interfaces.
const

Properties

bottom → bool: Whether to avoid system intrusions on the bottom side of the screen.
final
child → Widget: The widget below this widget in the tree.
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
left → bool: Whether to avoid system intrusions on the left.
final
maintainBottomViewPadding → bool: Specifies whether the SafeArea should maintain the bottom MediaQueryData.viewPadding instead of the bottom MediaQueryData.padding, defaults to false.
final
minimum → EdgeInsets: This minimum padding to apply.
final
right → bool: Whether to avoid system intrusions on the right.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
top → bool: Whether to avoid system intrusions at the top of the screen, typically the system status bar.
final

Methods

build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement: Creates a StatelessElement to manage this widget's location in the tree.
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
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, int wrapWidth = 65}) → 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

Operators

operator ==(Object other) → bool: The equality operator.
inherited