CustomProgressHud class
Wraps content with a modal "blocking" loading overlay. Shows a platform-appropriate spinner when isLoading is true: • iOS/macOS → CupertinoActivityIndicator • Android/others → CircularProgressIndicator
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- CustomProgressHud
- Available extensions
Constructors
- CustomProgressHud({Key? key, required Widget child, required bool isLoading, Widget? progressIndicator, Color? backgroundColor, double opacity = 0.6, Color color = Colors.black, bool dismissible = false, VoidCallback? onDismiss})
-
Creates a CustomProgressHud.
const
Properties
- backgroundColor → Color?
-
Background color of the overlay.
final
- child → Widget
-
The content over which the loading overlay is shown.
final
- color → Color
-
Color of the overlay background.
final
- dismissible → bool
-
Whether the overlay can be dismissed by tapping.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isLoading → bool
-
Whether to block the UI and show the spinner.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onDismiss → VoidCallback?
-
Callback when the overlay is dismissed.
final
- opacity → double
-
Opacity of the overlay background.
final
- progressIndicator → Widget?
-
Custom progress indicator widget.
If null, uses platform-appropriate default.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
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
-
withLoadingOverlay(
{required bool isLoading, String? message, Color? color, Color? backgroundColor, Widget? progressIndicator, TextStyle? messageStyle, double borderRadius = 12.0, EdgeInsetsGeometry padding = const EdgeInsets.all(24), bool dismissible = false, VoidCallback? onDismiss}) → Widget -
Available on Widget, provided by the LoadingOverlayExtension extension
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited