FAnimatedModalBarrier class

A widget that prevents the user from interacting with widgets behind itself, and can be configured with an animated value.

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.

Implementation details:

This class is a copy of AnimatedModalBarrier from Flutter 3.32.1 with the following enhancements:

Inheritance

Constructors

FAnimatedModalBarrier.new({required ImageFilter filter(double value)?, required VoidCallback? onDismiss, required Animation<double> animation, String? semanticsLabel, bool? barrierSemanticsDismissible, ValueNotifier<EdgeInsets>? clipDetailsNotifier, String? semanticsOnTapHint, Key? key})
Creates a FAnimatedModalBarrier that blocks user interaction.
const

Properties

animation → Animation<double>
If non-null, fill the barrier with this color.
no setter
barrierSemanticsDismissible → bool?
Whether the modal barrier semantics are included in the semantics tree.
final
clipDetailsNotifier → ValueNotifier<EdgeInsets>?
Contains a value of type EdgeInsets that specifies how the SemanticsNode.rect of the widget should be clipped.
final
filter → ImageFilter Function(double value)?
If non-null, applies the given ImageFilter to the barrier.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
listenable → Listenable
The Listenable to which this widget is listening.
finalinherited
onDismiss → VoidCallback?
Called when the barrier is being dismissed. Defaults to popping the current route from the ambient Navigator.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticsLabel → String?
Semantics label used for the barrier if it is dismissible.
final
semanticsOnTapHint → String?
This hint text instructs users what they are able to do when they tap on the FModalBarrier
final

Methods

build(BuildContext context) → Widget
Override this method to build widgets that depend on the state of the listenable (e.g., the current value of the animation).
override
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<AnimatedWidget>
Subclasses typically do not override this method.
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