UiLoadingOverlay class

A full-screen loading overlay with themed spinner.

// As a stack overlay:
Stack(children: [
  MyContent(),
  if (_loading) UiLoadingOverlay(message: 'Saving...'),
])

// Or show as a dialog:
UiLoadingOverlay.show(context: context, message: 'Loading...');
// ... later:
Navigator.pop(context);
Inheritance

Constructors

UiLoadingOverlay({Key? key, String? message, Color? barrierColor, double spinnerSize = 32.0})
const

Properties

barrierColor → Color?
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
message → String?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spinnerSize → double
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<UiLoadingOverlay>
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, 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

Static Methods

show({required BuildContext context, String? message}) → Future<void>
Shows as a modal overlay (pop to dismiss).