cue library

Classes

Act: A declarative description of a single animated property on a widget.
ActContext: Resolved animation context passed to an Act when building its animation.
ActKey: A type identifier for an Act.
Actor: A widget that applies one or more animation Acts to its child.
ActorState: Creates Actor State
AlignAct: Animates the alignment of a widget within its parent.
AnimatableValue<T>: Holds description of how a valueT animates between two states.
AnimatedValues: Default data class implementing Lerpable for common animated values.
BackdropBlurAct: Animates backdrop blur on a widget.
BlurAct: Animates blur intensity on a widget.
CardAct: Animates card-like surface properties: elevation shadow, background color, shadow color, surface tint color, and shape (border radius or arbitrary ShapeBorder).
CardActor: A convenience widget that animates card-like surface properties.
CardProps: A snapshot of card surface properties at a specific point in animation.
ClipAct: Animates clipping regions on a widget.
ClipGeometry: Defines the geometry shape for clipping operations.
ColorTintAct: Animates a color tint overlay on a widget.
ConstantAnimtable<T>: An CueAnimtable that always returns a fixed value.
Cue: The core animation widget. Provides a CueController through the widget tree so that Actor widgets anywhere below can consume it.
CueAnimation<T>: A Flutter Animation<T> that drives values via a CueAnimtable evaluated against the Cue timeline track.
CueAnimationImpl<T>: A CueAnimation with a fixed, pre-built CueAnimtable.
CueAnimtable<T>: Similar to Flutter's Animatable<T>, but evaluates via a driver (CueTrack).
CueController: An AnimationController that drives animations through a CueTimeline.
CueDebugTools
CueDialogRoute<T extends Object?>: A RawDialogRoute that drives its enter/exit transition with a CueController.
CueDragScrubber: A widget that scrubs the active CueController by dragging.
CueFlexibleSpaceBar: A Cue version of FlexibleSpaceBar, it drives cue animations based on the collapse progress of the flexible space bar.
CueIndexController: A change-notifier controller for manually controlled indexed animations.
CueModalTransition: A hero-like expand transition that morphs any widget into a full modal.
CueMotion: Describes how a value travels from one point to another over time.
CuePageController: A page controller that integrates with IndexedCue for animated page transitions.
CueScope: An InheritedWidget that exposes a CueController to the subtree.
CueTabController: A tab controller that integrates with IndexedCue for animated tab transitions.
CueTimeline: Base class for timeline implementations.
CueTimelineImpl: Manages and coordinates multiple animation tracks.
CueValueAnimator<T>: A standalone Animation<T> for animating a single value using CueMotion.
DebugDataProvider
DecoratedBoxAct: Animates box decoration properties (color, border, shadow, radius, gradient).
DecoratedBoxActor: Convenience widget for decoration animations.
DeferredCueAnimation<T>: A CueAnimation with deferred animatable setup.
DualAnimatable<T>: An CueAnimtable that selects between forward and reverse animatables.
ExpandingPathClipper: Custom clipper that creates an expanding path clip.
FKeyframe<T>: A keyframe positioned at a fractional point (0-1) within a duration.
FractionalKeyframes<T>: Keyframe sequence positioned at fractional points within a duration.
FractionalSize: Data class representing fractional sizing state.
FractionalSizeAct: Animates fractional sizing (width/height as fractions of parent).
IconThemeAct: Animates icon theme properties like color, size, and opacity.
InlineFnTween<T extends Object?>: Internal tween implementation for inline lerp functions.
Keyframe<T>: A keyframe with explicit motion timing.
KeyframeBase<T extends Object?>: Base class for keyframe types.
Keyframes<T>: Base abstraction for keyframe sequences.
KFReverseBehavior<T>: Reverse behavior for keyframed acts.
Lerpable<T extends Lerpable<T>>: Base interface for custom interpolatable types.
MotionKeyframes<T>: Keyframe sequence with explicit motion timing between frames.
NSize: A size specification where each axis can be null to mean "use the child's natural size for that axis" (no constraint applied).
OpacityAct: Animates widget opacity (transparency).
PaddingAct: Animates widget padding.
PaintAct: Animates custom painted content on a widget.
PaintActor: Convenience widget for custom paint animations.
Painter: Base interface for custom painters used by PaintAct and PaintActor.
ParallaxAct: Animates a parallax effect on child content.
PathMotionAct: Animates a widget along a custom path.
Phase<T extends Object?>: Represents a single animation segment (tween) from begin to end value.
Position: Represents edge and size constraints for positioned widgets in a Stack.
PositionAct: Animates widget positioning within a Stack.
PositionedActor: Convenience widget for position animations.
ReleaseToken: Token for managing track lifecycle and release.
RepeatConfig: Configuration for repeating animations.
ReverseBehavior<T>: Reverse behavior for tween acts.
ReverseBehaviorBase<T>: Base class for reverse behavior, shared by tween and keyframed acts.
Rotate3DAct: Animates 3D rotation around multiple axes simultaneously.
RotateAct: Animates widget rotation using transforms.
RotateLayoutAct: Rotates the widget's layout during animation.
Rotation3D: Represents 3D rotation values around multiple axes.
ScaleAct: Animates uniform scaling of a widget (both X and Y axes equally).
SegmentedAnimtable<T>: An CueAnimtable that selects and evaluates an evaluator based on phase.
SelfAnimatedCue: Base class for Cue variants that own and manage their CueController.
SimulationBuildData: Runtime context passed to CueMotion.build when constructing a simulation.
SimulationMotion<S extends CueSimulation>: Base class for physics-driven motions that produce a specific simulation type S.
SingleActorBase<T>: A convenience base class for widgets that wrap a single Act in an Actor.
SizedBoxAct: Animates widget size using width and/or height constraints.
SizedClipAct: Animates widget size with clipping and optional rounding.
Skew: Represents a 2D skew transformation with x and y angles.
SkewAct: Animates skew transformations on the X and Y axes.
SlideAct: Animates widget position by sliding it as a fraction of its own size.
Spring: A physics-based spring motion that models a damped harmonic oscillator.
Stretch: Non-uniform scaling factors with separate X and Y values.
StretchAct: Animates non-uniform scaling with separate X and Y scale factors.
TextStyleAct: Animates text style properties like color, size, weight, and more.
TimedMotion: A CueMotion that drives animations with a fixed Duration and a Curve.
TimelineEvent: Base class for timeline events.
TimelinePrepareEvent: Event fired when timeline is prepared for animation.
TimelineWillAnimateEvent: Event fired before timeline begins animating.
TrackEntry: Container for a track and its active release tokens.
TransformAct: Animates arbitrary 3D transformations using Matrix4.
TranslateAct: Animates widget position using absolute pixel distances.
TranslateTransition: A widget that applies a translate transform based on an animation.
TweenAct<T>: Simplified TweenActBase where the animated value type equals the input type.
TweenActBase<T extends Object?, R extends Object?>: Base for tween-based and keyframed acts with value transformation.
TweenActor<T extends Object?>: Convenience widget for custom tween animations.
TweenAnimtable<T>: An CueAnimtable that wraps a standard Flutter Animatable.

Enums

CueDragReleaseMode: Controls what happens when the user releases the drag.
CueScrubDirection: Controls the direction of scrubbing when the user drags to scrub the animation.
ReverseBehaviorType: Enumeration of reverse behavior types for tween-based and keyframed acts.
Rotate3DUnit: Unit for 3D rotation values in Rotate3DAct.
RotateAxis: Axis of rotation for RotateAct.
RotateUnit: Unit for rotation values in RotateAct and RotateLayoutAct.

Mixins

CueModalRouteMixin<T extends Object?>: A mixin for ModalRoutes that want to use Cue for their transition animations.
IndexedCueController: The controller protocol for IndexedCue.

Extensions

ActorExtenstion on Widget: Convenience extension to attach Actor acts to any widget using .act([...]) shorthand.
DoubleDurationExtension on double: Extensions on double for convenient duration literals.
DurationExtension on int: Extensions on int for convenient duration literals.

Functions

showCueDialog<T>({required BuildContext context, required WidgetBuilder builder, bool barrierDismissible = true, String barrierLabel = 'CueDialog', Color barrierColor = const Color(0x80000000), CueMotion motion = .defaultTime, CueMotion? reverseMotion, bool useRootNavigator = true}) → Future<T?>: Shows a Cue-animated dialog using CueDialogRoute.

Typedefs

ModalContentBuilder = Widget Function(BuildContext context, Rect triggerRect): Signature for the modal content builder used by CueModalTransition.
PaintaerCallback = void Function(Canvas canvas, Size size, double progress): Callback signature for inline custom painters.
ShowModalFunction<T extends Object> = Future<T?> Function(): Signature for the function that shows the modal, passed to triggerBuilder.
TweenBuilder<T> = Tween<T> Function({T? begin, T? end}): A factory function that creates Tween<T> instances.
ValueTransformer<R, T> = R Function(ActContext context, T value): Signature for a function that transforms a value from its stored type T to an animated type R.

Classes

Enums

Mixins

Extensions

Functions

Typedefs

cue package

cue library