PrismLoadingOverlay class
A full-screen or scoped overlay that blocks interaction while loading.
Wraps child with a translucent scrim, a spinner and an optional message, and only renders when isLoading is true. Useful for a network call where the user should not be able to tap anything while it is in flight.
PrismLoadingOverlay(
isLoading: state.isSubmitting,
message: 'Saving…',
child: const MyForm(),
)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- PrismLoadingOverlay
Constructors
- PrismLoadingOverlay({Key? key, required bool isLoading, required Widget child, String? message, Color? color, Color? backgroundColor, Widget? loadingIcon, BorderRadius? borderRadius})
-
Creates a loading overlay.
const
Properties
- backgroundColor → Color?
-
Background of the scrim. Defaults to a translucent surface colour.
final
- borderRadius → BorderRadius?
-
Corner radius, when the overlay is scoped to a box.
final
- child → Widget
-
The content underneath.
final
- color → Color?
-
Spinner colour. Defaults to the theme's primary.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isLoading → bool
-
Whether the overlay is shown.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loadingIcon → Widget?
-
Replaces the spinner with a custom widget.
final
- message → String?
-
Message shown under the spinner.
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