FlutterSplashScreen class

Inheritance

Constructors

FlutterSplashScreen({Key? key, Duration? duration, Color? backgroundColor = Colors.black, Widget? splashScreenBody, Widget? nextScreen, Duration setStateTimer = const Duration(milliseconds: 100), VoidCallback? setStateCallback, VoidCallback? onInit, VoidCallback? onEnd, AsyncCallback? asyncNavigationCallback, bool useImmersiveMode = false})
FlutterSplashScreen.fadeIn({Key? key, Widget? nextScreen, required Widget? childWidget, Curve animationCurve = Curves.ease, Duration? animationDuration = const Duration(milliseconds: 2000), Duration? duration, Color? backgroundColor = Colors.black, Duration setStateTimer = const Duration(milliseconds: 200), VoidCallback? onAnimationEnd, VoidCallback? onInit, VoidCallback? onEnd, AsyncCallback? asyncNavigationCallback, Image? backgroundImage, Gradient? gradient, bool useImmersiveMode = false})
Provides ready-made fadeIn templated splash;
FlutterSplashScreen.gif({Key? key, required String? gifPath, required double? gifWidth, required double? gifHeight, Widget? nextScreen, Duration? duration, Color? backgroundColor = Colors.black, Duration setStateTimer = const Duration(milliseconds: 100), VoidCallback? setStateCallback, VoidCallback? onInit, VoidCallback? onEnd, AsyncCallback? asyncNavigationCallback, Image? backgroundImage, Gradient? gradient, bool useImmersiveMode = false})
Provides ready-made gif templated splash;
FlutterSplashScreen.scale({Key? key, Widget? nextScreen, required Widget? childWidget, Curve animationCurve = Curves.ease, Duration? animationDuration = const Duration(milliseconds: 2000), Duration? duration, Color? backgroundColor = Colors.black, Duration setStateTimer = const Duration(milliseconds: 200), VoidCallback? onAnimationEnd, VoidCallback? onInit, VoidCallback? onEnd, AsyncCallback? asyncNavigationCallback, Image? backgroundImage, Gradient? gradient, bool useImmersiveMode = false})
Provides ready-made fadeIn templated splash;

Properties

animationCurve ↔ Curve
Takes curve of animation.
getter/setter pair
animationDuration ↔ Duration?
Duration to complate opacity animation.
getter/setter pair
asyncNavigationCallback ↔ AsyncCallback?
An AsyncCallback used to perform some operations asynchronously. E.g. Loading data from server before moving to next screen. Do not use duration while using asyncCallback. It just doesn't make sense.
getter/setter pair
backgroundColor ↔ Color?
Background color of flutter splash screen scaffold.
getter/setter pair
backgroundImage ↔ Image?
Sets full screen background image.
getter/setter pair
childWidget ↔ Widget?
A child Widget which will be shown during opacity animation.
getter/setter pair
duration ↔ Duration?
Duration for how long flutter splash screen should stay.
getter/setter pair
gifHeight ↔ double?
Height of gif.
getter/setter pair
gifPath ↔ String?
File path of gif.
getter/setter pair
gifWidth ↔ double?
Width of gif.
getter/setter pair
gradient ↔ Gradient?
Sets full screen gradient.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
nextScreen ↔ Widget?
Default screen to which app should navigate to after flutter splash screen if asyncNavigationCallback is not provided.
getter/setter pair
onAnimationEnd ↔ VoidCallback?
A VoidCallback which will be triggered after flutter splash screen Duration.
getter/setter pair
onEnd ↔ VoidCallback?
A VoidCallback which will be triggered after flutter splash screen Duration.
getter/setter pair
onInit ↔ VoidCallback?
A VoidCallback which will be triggered on flutter splash screen initialization.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
setStateCallback ↔ VoidCallback?
A VoidCallback which will be triggered on when splashScreenBody's state is set.
getter/setter pair
setStateTimer ↔ Duration
Duration to set the state of splashScreenBody.
getter/setter pair
splashScreenBody ↔ Widget?
Widget wrapped inside a Scaffold which will be shown at flutter splash screen duration.
getter/setter pair
splashType ↔ SplashType
getter/setter pair
useImmersiveMode ↔ bool
Hides status bar and shows splash screen on full screen.
getter/setter pair

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<FlutterSplashScreen>
Creates the mutable state for this widget at a given location in the tree.
override
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}) → 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