ModalBarrier class Null safety
A widget that prevents the user from interacting with widgets behind itself.
The modal barrier is the scrim that is rendered behind each route, which generally prevents the user from interacting with the route below the current route, and normally partially obscures such routes.
For example, when a dialog is on the screen, the page below the dialog is usually darkened by the modal barrier.
See also:
- ModalRoute, which indirectly uses this widget.
- AnimatedModalBarrier, which is similar but takes an animated color instead of a single color value.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- ModalBarrier
Constructors
- ModalBarrier({Key? key, Color? color, bool dismissible = true, VoidCallback? onDismiss, String? semanticsLabel, bool? barrierSemanticsDismissible = true})
-
Creates a widget that blocks user interaction.
const
Properties
- barrierSemanticsDismissible → bool?
-
Whether the modal barrier semantics are included in the semantics tree.
final
- color → Color?
-
If non-null, fill the barrier with this color.
final
- dismissible → bool
-
Specifies if the barrier will be dismissed when the user taps on it.
final
- hashCode → int
- The hash code for this object.
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onDismiss → VoidCallback?
-
Called when the barrier is being dismissed.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- semanticsLabel → String?
-
Semantics label used for the barrier if it is dismissible.
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.protected">@protectedinherited -
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent 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
Operators
-
operator ==(
Object other) → bool -
The equality operator.
nonVirtual">@nonVirtualinherited