DialogModalLayer class

Semi-transparent overlay over a parent window while a modal dialog is open.

Place at the root of each window that can host modal dialogs so the scrim covers the full window surface:

runMultiApp(
  home: (context, id) => DialogModalLayer(
    child: MyHomeScreen(),
  ),
);

When openDialog is called with modal: true, the scrim fades in over the parent content. Native modal dialogs also block input on the parent at the OS level on supported platforms; this widget adds visual dimming only.

The Flutter scrim blocks pointer events to widgets below it while visible. OS-level blocking is handled separately by the native layer when modal: true.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatelessWidget
• DialogModalLayer

Constructors

DialogModalLayer({Key? key, required Widget child, bool showBarrierForNotModalDialog = false, Color barrierColor = const Color(0x80000000), Duration animationDuration = const Duration(milliseconds: 150)})

const

Properties

animationDuration → Duration

Fade duration when the scrim appears or disappears.

final

barrierColor → Color

Scrim color. Defaults to semi-transparent black.

final

child → Widget

Content shown beneath the scrim.

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

showBarrierForNotModalDialog → bool

When true, a scrim is also shown for non-modal (modeless) child dialogs. Tapping the scrim focuses the topmost modeless dialog.

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.

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, 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