msb-public
/
samples
mirror of https://github.com/flutter/samples.git
1
0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3324bfc20e'
${ noResults }
samples/android_splash_screen
History
Brett Morgan 7d169b4d98
Update for 3.13 stable (#1992) 		1 year ago
..
android Migrate from `jcenter` to `mavenCentral` (#1230) 3 years ago
images Add android_splash_screen (#903) 3 years ago
lib enable Material 3 on android_splash_screen sample (#1604) 2 years ago
test Add android_splash_screen (#903) 3 years ago
.gitignore Add android_splash_screen (#903) 3 years ago
.metadata Add android_splash_screen (#903) 3 years ago
README.md Add android_splash_screen (#903) 3 years ago
analysis_options.yaml Create `analysis_defaults` package (#1654) 2 years ago
pubspec.yaml Update for 3.13 stable (#1992) 1 year ago

README.md

Splash Screen Sample

A Flutter app that exemplifies how to implement an animated splash screen for Android devices running at least Android 12, the version that supplies the new SplashScreen API.

NOTE: There is a pub package available to implement static splash screens in your Flutter app: flutter_native_splash.

Goals

  • Demonstrate the compatibility of animated splash screens and Flutter apps running on Android
  • Demonstrate the smoothness achievable by a splash screen as a transition to the Flutter UI

The important bits

Remove deprecated code

When creating a Flutter app, the Android code generated may include the deprecated implementation of a splash screen. This includes a definition of io.flutter.embedding.android.SplashScreenDrawable in the /android/app/src/main/AndroidManifest.xml file and an implementation of provideSplashScreen() in the /android/app/src/main/kotlin/MainActivity.kt file. Make sure to remove this code.

NOTE: This should no longer be a concern as of Flutter 2.5.

Modify Android build files

In order to support the Android 12 SplashScreen API, you need to:

  1. Update the Android compileSdkVersion to 31 in the /android/app/build.gradle file, and
  2. Update the ext.kotlin_version to the latest Kotlin extension version (1.5.31 at the time of publication) in the /android/build.gradle file.

Timing the splash screen animation

In order to ensure a smooth transition between the animated splash screen and the Flutter UI displaying for the first time, be sure to handle both the case where the Flutter UI is ready to be displayed before the animation finishes and vice versa. This can be done by overriding onFlutterUiDisplayed() and onFlutterUiNoLongerDisplayed() in /android/app/src/main/kotlin/com/example/splash-screen-sample/MainActivity.kt, the implementation of FlutterActivity in this project.

Questions/Issues

If you have a general question about splash screens or their implementation in Flutter, the best places to go are:

If you run into an issue with the sample itself, please file an issue in the main Flutter repo.