LoadingPanel class - risto_loading_overlay library

Constructors

LoadingPanel({Key? key, required bool isLoading, Widget? child, String? message, double? progress, RistoLoaderStyle loaderStyle = RistoLoaderStyle.adaptive, Color? barrierColor, Color? loaderColor, double blurSigma = 4.0, EdgeInsetsGeometry? padding, EdgeInsetsGeometry? margin, BorderRadius? barrierBorderRadius}): const
LoadingPanel.asOverlay({Key? key, required String message, double? progress, BorderRadius? borderRadius, RistoLoaderStyle loaderStyle = RistoLoaderStyle.pulsingDots}): A specialized factory meant to be dropped directly into a Stack or over a constrained area. It defaults to isLoading: true (since you typically only inject it when needed) and uses a slightly lower blur and lighter barrier color to match your old implementation.
factory
LoadingPanel.clear({Key? key, required bool isLoading, Widget? child, String? message, double? progress, RistoLoaderStyle loaderStyle = RistoLoaderStyle.adaptive, Color? loaderColor, EdgeInsetsGeometry? padding, EdgeInsetsGeometry? margin}): Creates a loading overlay with no blur and a fully transparent barrier.
factory
LoadingPanel.dark({Key? key, required bool isLoading, Widget? child, String? message, double? progress, RistoLoaderStyle loaderStyle = RistoLoaderStyle.pulsingDots, Color? loaderColor, EdgeInsetsGeometry? padding, EdgeInsetsGeometry? margin}): Creates a loading overlay with a dark, semi-transparent barrier.
factory
LoadingPanel.glass({Key? key, required bool isLoading, Widget? child, String? message, double? progress, RistoLoaderStyle loaderStyle = RistoLoaderStyle.adaptive, Color? loaderColor, EdgeInsetsGeometry? padding, EdgeInsetsGeometry? margin}): Creates a loading overlay with a high-blur, glass-like barrier.
factory

Properties

barrierBorderRadius → BorderRadius?: Optional border radius for the outermost barrier (useful when wrapping non-rectangular content).
final
barrierColor → Color?: Custom background color for the overlay barrier.
final
blurSigma → double: The blur amount for the background (X and Y). Defaults to 4.0.
final
child → Widget?: The widget to display behind the overlay (used for local overlays).
final
hashCode → int: The hash code for this object.
no setterinherited
isLoading → bool: Whether the loading overlay is currently visible.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
loaderColor → Color?: Custom color for the loader widget (spinner or dots).
final
loaderStyle → RistoLoaderStyle: The visual style of the loader.
final
margin → EdgeInsetsGeometry?: The external margin of the loader panel.
final
message → String?: The message to display below the loader.
final
padding → EdgeInsetsGeometry?: The internal padding of the loader panel. Defaults to horizontal 24, vertical 16.
final
progress → double?: The progress value (0.0 to 1.0) to display a progress bar.
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

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

isShowing → bool: Returns true if the global loading overlay is currently visible.
no setter

Static Methods

hide(BuildContext context) → void: Hides the currently visible global loading panel, if any.
show(BuildContext context, {String? message, double? progress, RistoLoaderStyle loaderStyle = RistoLoaderStyle.pulsingDots, double blurSigma = 6.0, Color? barrierColor, Color? loaderColor, EdgeInsetsGeometry? padding, EdgeInsetsGeometry? margin}) → void: Shows the loading panel as a full-screen, modal dialog. Prevents user interaction while loading.