LoaderOverlay class
Class that effectively display the overlay on the screen. It's a Stateful widget so we can dispose when not needed anymore
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- LoaderOverlay
Constructors
-
LoaderOverlay({Key? key, Widget overlayWidgetBuilder(dynamic progress)?, bool useDefaultLoading = useDefaultLoadingValue, Color? overlayColor, bool disableBackButton = true, bool overlayWholeScreen = true, double? overlayHeight, double? overlayWidth, bool closeOnBackButton = false, Duration duration = Duration.zero, Duration? reverseDuration = Duration.zero, Curve switchInCurve = Curves.linear, Curve switchOutCurve = Curves.linear, Widget transitionBuilder(Widget, Animation<
double> ) = AnimatedSwitcher.defaultTransitionBuilder, Widget layoutBuilder(Widget?, List<Widget> ) = AnimatedSwitcher.defaultLayoutBuilder, bool useBackButtonInterceptor = !kIsWeb, required Widget child}) -
const
Properties
- child → Widget
-
The child that will have the overlay upon
final
- closeOnBackButton → bool
-
final
- disableBackButton → bool
-
Whether or not to disable the back button while loading.
final
- duration → Duration
-
The duration when the overlay enters
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
layoutBuilder
→ Widget Function(Widget?, List<
Widget> ) -
The layout builder for the overlay
final
- overlayColor → Color?
-
The color of the overlay
final
- overlayHeight → double?
-
The desired height of the overlay
final
- overlayWholeScreen → bool
-
This should be false if you want to have full control of the size of the overlay.
This is generally used in conjunction with overlayHeight and overlayWidth to
define the desired size of the overlay.
final
- overlayWidgetBuilder → (Widget Function(dynamic progress)?)
-
The widget of the overlay. This is great if you want to insert your own widget to serve as
an overlay.
final
- overlayWidth → double?
-
The desired width of the overlay
final
- reverseDuration → Duration?
-
The duration when the overlay exits
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- switchInCurve → Curve
-
The curve for the overlay to transition in
final
- switchOutCurve → Curve
-
The curve for the overlay to transition out
final
-
transitionBuilder
→ Widget Function(Widget, Animation<
double> ) -
The transition builder for the overlay
final
- useBackButtonInterceptor → bool
-
final
- useDefaultLoading → bool
-
Whether or not to use a default loading if none is provided.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _LoaderOverlayState -
Creates the mutable state for this widget at a given location in the tree.
override
-
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}) → 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
Static Properties
- defaultOverlayColor ↔ Color
-
getter/setter pair
Constants
- containerForOverlayColorKey → const Key
- defaultOverlayWidgetKey → const Key
- useDefaultLoadingValue → const bool