OverlayLottie<T extends StatefulWidget> mixin
Mixin that helps to overlay a Lottie animation over a content upon request (i.e. call of showLottieOverlay, showLottieOverlayDuring or showLottieOverlayWhile). It enables a control on the repetitions of the animation.
- Superclass constraints
Properties
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- widget → T
-
The current configuration.
no setterinherited
Methods
-
activate(
) → void -
Called when this object is reinserted into the tree after having been
removed via deactivate.
inherited
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
inherited
-
buildWithLottieOverlay(
{required Widget child, String? animationUrl, Duration? durationPerRepetition, int defaultNumberOfRepetitions = 1, bool blurContent = false, double opacity = 0.8, VoidCallback? onHide, bool fadeIn = true}) → Widget -
Builds the structure of the widget with an animation. The content shown is
child
, but if the animation is being shown, andanimationUrl
is provided, then a lottie animation is overlayed and the child is deactivated. -
createTicker(
TickerCallback onTick) → Ticker -
Creates a ticker with the given callback.
inherited
-
deactivate(
) → void -
Called when this object is removed from the tree.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
didChangeDependencies(
) → void -
Called when a dependency of this State object changes.
inherited
-
didUpdateWidget(
covariant T oldWidget) → void -
Called whenever the widget configuration changes.
inherited
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
override
-
hideLottieOverlay(
[bool force = false]) → void -
Stops the animation. If the animation is not being shown, the state is not changed unless
forced
is set to true. -
initState(
) → void -
Called when this object is inserted into the tree.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
inherited
-
showLottieOverlay(
{bool? force, int? repetitions, String? animationUrl, VoidCallback? onHide}) → Future< bool> -
showLottieOverlayDuring(
Duration period, {String? animationUrl, VoidCallback? onHide}) → Future< bool> -
Shortcut to show the animation during a
period
. -
showLottieOverlayWhile(
Function callback, {Duration? timeout, Function? onTimeout, String? animationUrl, VoidCallback? onHide}) → Future< bool> -
Shortcut to show the animation while a
callback
is executed. If provided, aftertimeout
period, the execution ofcallback
will be aborted and (if provided), functiononTimeout
will be called. -
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
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited