EasyLoading class
Global facade for displaying loading, progress, result, and toast overlays.
Constructors
- EasyLoading()
-
Returns the shared configuration instance.
factory
Properties
- animationDuration ↔ Duration
-
Duration of panel presentation and dismissal transitions.
getter/setter pair
- animationStyle ↔ EasyLoadingAnimationStyle
-
Transition used to present and dismiss the panel.
getter/setter pair
- backgroundColor ↔ Color?
-
Panel background color required by the custom loading style.
getter/setter pair
-
boxShadow
↔ List<
BoxShadow> ? -
Shadows drawn behind a custom panel.
getter/setter pair
- contentPadding ↔ EdgeInsets
-
Padding between the panel boundary and its content.
getter/setter pair
- customAnimation ↔ EasyLoadingAnimation?
-
Transition implementation required by the custom animation style.
getter/setter pair
- dismissOnTap ↔ bool?
-
Whether tapping the barrier dismisses the current overlay.
getter/setter pair
- displayDuration ↔ Duration
-
Default lifetime of result and toast messages.
getter/setter pair
- errorWidget ↔ Widget?
-
Optional replacement for the built-in error icon.
getter/setter pair
- fontSize ↔ double
-
Font size used when textStyle is not supplied.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- indicatorColor ↔ Color?
-
Indicator color required by the custom loading style.
getter/setter pair
- indicatorSize ↔ double
-
Width and height of the built-in indicator.
getter/setter pair
- indicatorType ↔ EasyLoadingIndicatorType
-
Built-in indicator used by loading calls.
getter/setter pair
- indicatorWidget ↔ Widget?
-
Optional replacement for the built-in loading indicator.
getter/setter pair
- infoWidget ↔ Widget?
-
Optional replacement for the built-in information icon.
getter/setter pair
- lineWidth ↔ double
-
Stroke width used by supported built-in indicators.
getter/setter pair
- loadingStyle ↔ EasyLoadingStyle
-
Color scheme used by the panel.
getter/setter pair
- maskColor ↔ Color?
-
Barrier color required by the custom mask type.
getter/setter pair
- maskType ↔ EasyLoadingMaskType
-
Default interaction barrier used by display calls.
getter/setter pair
- progressColor ↔ Color?
-
Progress ring color required by custom determinate progress.
getter/setter pair
- progressWidth ↔ double
-
Stroke width of the determinate progress ring.
getter/setter pair
- radius ↔ double
-
Corner radius of the panel.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- successWidget ↔ Widget?
-
Optional replacement for the built-in success icon.
getter/setter pair
- textAlign ↔ TextAlign
-
Alignment of status text inside the panel.
getter/setter pair
- textColor ↔ Color?
-
Status text color required by the custom loading style.
getter/setter pair
- textPadding ↔ EdgeInsets
-
Padding inserted between an indicator and status text.
getter/setter pair
- textStyle ↔ TextStyle?
-
Complete status text style, merged with the surrounding Material style.
getter/setter pair
- toastPosition ↔ EasyLoadingToastPosition
-
Default vertical placement of text-only toast messages.
getter/setter pair
- userInteractions ↔ bool?
-
Whether pointer input can reach the application below the overlay.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance → EasyLoading
-
Shared mutable configuration used by subsequent display calls.
no setter
- isShow → bool
-
Whether an EasyLoading overlay is currently active.
no setter
Static Methods
-
addDismissCallback(
EasyLoadingDismissCallback callback) → void - Adds a final dismissal-reason callback.
-
addStatusCallback(
EasyLoadingStatusCallback callback) → void - Adds a visibility callback if it has not already been registered.
-
dismiss(
{bool animation = true}) → Future< void> - Dismisses the active overlay.
-
init(
{TransitionBuilder? builder}) → TransitionBuilder - Creates the application-level EasyLoading Host builder.
-
removeAllCallbacks(
) → void - Removes every visibility callback.
-
removeAllDismissCallbacks(
) → void - Removes every dismissal-reason callback.
-
removeCallback(
EasyLoadingStatusCallback callback) → void - Removes one visibility callback.
-
removeDismissCallback(
EasyLoadingDismissCallback callback) → void - Removes one dismissal-reason callback.
-
show(
{String? status, Widget? indicator, EasyLoadingMaskType? maskType, bool? dismissOnTap, Duration? duration, EasyLoadingOptions? options}) → Future< void> - Shows or updates an indeterminate loading indicator.
-
showCustom(
Widget content, {Duration? duration, EasyLoadingMaskType? maskType, bool? dismissOnTap, EasyLoadingOptions? options}) → Future< void> - Shows arbitrary content inside the EasyLoading presentation layer.
-
showError(
String status, {Duration? duration, EasyLoadingMaskType? maskType, bool? dismissOnTap, EasyLoadingOptions? options}) → Future< void> - Shows an error result using displayDuration by default.
-
showInfo(
String status, {Duration? duration, EasyLoadingMaskType? maskType, bool? dismissOnTap, EasyLoadingOptions? options}) → Future< void> - Shows an information result using displayDuration by default.
-
showProgress(
double value, {String? status, EasyLoadingMaskType? maskType, Widget? indicator, Duration? duration, bool? dismissOnTap, EasyLoadingOptions? options}) → Future< void> - Shows or updates determinate progress in the inclusive range 0 to 1.
-
showSuccess(
String status, {Duration? duration, EasyLoadingMaskType? maskType, bool? dismissOnTap, EasyLoadingOptions? options}) → Future< void> - Shows a success result using displayDuration by default.
-
showToast(
String status, {Duration? duration, EasyLoadingToastPosition? toastPosition, EasyLoadingMaskType? maskType, bool? dismissOnTap, EasyLoadingOptions? options}) → Future< void> - Shows a text-only toast using displayDuration by default.