SplashConfig class
Configuration model for the splash screen.
Passed to SmartSplash to control every aspect of the splash experience.
Constructors
- SplashConfig({int durationMs = 2500, SplashAnimation animation = const SplashAnimation(type: SplashAnimationType.fadeIn), Color? backgroundColor, LinearGradient? backgroundGradient, Widget? logo, String? appName, String? tagline, TextStyle? appNameStyle, TextStyle? taglineStyle, SplashLayoutType layoutType = SplashLayoutType.logoCenter, Widget? customContent, SplashTheme? theme, bool showLoader = false, Widget? customLoader, bool tapToContinue = false, bool showSkipButton = false, String skipButtonLabel = 'Skip', bool enablePerformanceMonitoring = false})
-
Creates a SplashConfig.
const
Properties
- animation → SplashAnimation
-
The animation to apply to the splash content.
final
- appName → String?
-
App name text shown below the logo.
final
- appNameStyle → TextStyle?
-
Text style for appName.
final
- backgroundColor → Color?
-
Solid background color. Ignored if backgroundGradient is set.
final
- backgroundGradient → LinearGradient?
-
Gradient background. Takes priority over backgroundColor.
final
- customContent → Widget?
-
A fully custom widget to use as the splash content. Requires layoutType = SplashLayoutType.custom.
final
- customLoader → Widget?
-
Custom loading indicator widget. Defaults to CircularProgressIndicator.
final
- durationMs → int
-
Total duration the splash is visible, in milliseconds.
final
- enablePerformanceMonitoring → bool
-
Whether to enable performance monitoring (debug builds only).
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- layoutType → SplashLayoutType
-
Layout type for the splash UI.
final
- logo → Widget?
-
The logo widget to display (e.g. Image.asset, FlutterLogo).
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showLoader → bool
-
Whether to show a loading indicator while
onInitruns.final - showSkipButton → bool
-
Whether to show a skip button.
final
- skipButtonLabel → String
-
Label for the skip button.
final
- tagline → String?
-
Tagline or subtitle text.
final
- taglineStyle → TextStyle?
-
Text style for tagline.
final
- tapToContinue → bool
-
Whether to enable the interactive "tap to continue" mode.
final
- theme → SplashTheme?
-
Theme controlling colors of the splash screen.
final
Methods
-
copyWith(
{int? durationMs, SplashAnimation? animation, Color? backgroundColor, LinearGradient? backgroundGradient, Widget? logo, String? appName, String? tagline, TextStyle? appNameStyle, TextStyle? taglineStyle, SplashLayoutType? layoutType, Widget? customContent, SplashTheme? theme, bool? showLoader, Widget? customLoader, bool? tapToContinue, bool? showSkipButton, String? skipButtonLabel, bool? enablePerformanceMonitoring}) → SplashConfig - Returns a copy of this config with specified fields overridden.
-
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