flutter_native_splash.yaml 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. flutter_native_splash:
  2. # This package generates native code to customize Flutter's default white native splash screen
  3. # with background color and splash image.
  4. # Customize the parameters below, and run the following command in the terminal:
  5. # dart run flutter_native_splash:create
  6. # To restore Flutter's default white splash screen, run the following command in the terminal:
  7. # dart run flutter_native_splash:remove
  8. # IMPORTANT NOTE: These parameter do not affect the configuration of Android 12 and later, which
  9. # handle splash screens differently that prior versions of Android. Android 12 and later must be
  10. # configured specifically in the android_12 section below.
  11. # color or background_image is the only required parameter. Use color to set the background
  12. # of your splash screen to a solid color. Use background_image to set the background of your
  13. # splash screen to a png image. This is useful for gradients. The image will be stretch to the
  14. # size of the app. Only one parameter can be used, color and background_image cannot both be set.
  15. color: "#000000"
  16. # background_image: "assets/icon_splash.png"
  17. # Optional parameters are listed below. To enable a parameter, uncomment the line by removing
  18. # the leading # character.
  19. # The image parameter allows you to specify an image used in the splash screen. It must be a
  20. # png file and should be sized for 4x pixel density.
  21. image: assets/icon_splash.png
  22. # The branding property allows you to specify an image used as branding in the splash screen.
  23. # It must be a png file. It is supported for Android, iOS and the Web. For Android 12,
  24. # see the Android 12 section below.
  25. #branding: assets/dart.png
  26. # To position the branding image at the bottom of the screen you can use bottom, bottomRight,
  27. # and bottomLeft. The default values is bottom if not specified or specified something else.
  28. #branding_mode: bottom
  29. # Set the branding padding from the bottom of the screen. The default value is 0
  30. # (Not supported on web yet)
  31. # branding_bottom_padding: 24
  32. # The color_dark, background_image_dark, image_dark, branding_dark are parameters that set the background
  33. # and image when the device is in dark mode. If they are not specified, the app will use the
  34. # parameters from above. If there is no parameter above, the app will use the light mode values.
  35. # If the image_dark parameter is specified, color_dark or background_image_dark must be specified.
  36. # color_dark and background_image_dark cannot both be set.
  37. #color_dark: "#042a49"
  38. #background_image_dark: "assets/dark-background.png"
  39. #image_dark: assets/splash-invert.png
  40. #branding_dark: assets/dart_dark.png
  41. # From Android 12 onwards, the splash screen is handled differently than in previous versions.
  42. # Please visit https://developer.android.com/guide/topics/ui/splash-screen
  43. # Following are specific parameters for Android 12+.
  44. android_12:
  45. # The image parameter sets the splash screen icon image. If this parameter is not specified,
  46. # the app's launcher icon will be used instead.
  47. # Please note that the splash screen will be clipped to a circle on the center of the screen.
  48. # App icon with an icon background: This should be 960×960 pixels, and fit within a circle
  49. # 640 pixels in diameter.
  50. # App icon without an icon background: This should be 1152×1152 pixels, and fit within a circle
  51. # 768 pixels in diameter. To fit a 1152x1152 image within a circle with a 768 diameter, simply
  52. # ensure that the most important design elements of your image are placed within a circular area
  53. # with a 768 diameter at the center of the 1152x1152 canvas.
  54. image: assets/icon_splash.png
  55. # Splash screen background color.
  56. color: "#000000"
  57. # App icon background color.
  58. icon_background_color: "#000000"
  59. # The branding property allows you to specify an image used as branding in the splash screen.
  60. #branding: assets/dart.png
  61. # The image_dark, color_dark, icon_background_color_dark, and branding_dark set values that
  62. # apply when the device is in dark mode. If they are not specified, the app will use the
  63. # parameters from above. If there is no parameter above, the app will use the light mode values.
  64. #image_dark: assets/android12splash-invert.png
  65. #color_dark: "#042a49"
  66. #icon_background_color_dark: "#eeeeee"
  67. # The android, ios and web parameters can be used to disable generating a splash screen on a given
  68. # platform.
  69. #android: false
  70. #ios: false
  71. #web: false
  72. # Platform specific images can be specified with the following parameters, which will override
  73. # the respective parameter. You may specify all, selected, or none of these parameters:
  74. #color_android: "#42a5f5"
  75. #color_dark_android: "#042a49"
  76. #color_ios: "#42a5f5"
  77. #color_dark_ios: "#042a49"
  78. #color_web: "#42a5f5"
  79. #color_dark_web: "#042a49"
  80. #image_android: assets/splash-android.png
  81. #image_dark_android: assets/splash-invert-android.png
  82. #image_ios: assets/splash-ios.png
  83. #image_dark_ios: assets/splash-invert-ios.png
  84. #image_web: assets/splash-web.gif
  85. #image_dark_web: assets/splash-invert-web.gif
  86. #background_image_android: "assets/background-android.png"
  87. #background_image_dark_android: "assets/dark-background-android.png"
  88. #background_image_ios: "assets/background-ios.png"
  89. #background_image_dark_ios: "assets/dark-background-ios.png"
  90. #background_image_web: "assets/background-web.png"
  91. #background_image_dark_web: "assets/dark-background-web.png"
  92. #branding_android: assets/brand-android.png
  93. #branding_bottom_padding_android: 24
  94. #branding_dark_android: assets/dart_dark-android.png
  95. #branding_ios: assets/brand-ios.png
  96. #branding_bottom_padding_ios: 24
  97. #branding_dark_ios: assets/dart_dark-ios.png
  98. #branding_web: assets/brand-web.gif
  99. #branding_dark_web: assets/dart_dark-web.gif
  100. # The position of the splash image can be set with android_gravity, ios_content_mode, and
  101. # web_image_mode parameters. All default to center.
  102. #
  103. # android_gravity can be one of the following Android Gravity (see
  104. # https://developer.android.com/reference/android/view/Gravity): bottom, center,
  105. # center_horizontal, center_vertical, clip_horizontal, clip_vertical, end, fill, fill_horizontal,
  106. # fill_vertical, left, right, start, or top. android_gravity can be combined using the | operator to achieve multiple effects.
  107. # For example:
  108. # `android_gravity: fill|clip_vertical` - This will fill the width while maintaining the image's vertical aspect ratio
  109. #android_gravity: center
  110. #
  111. # ios_content_mode can be one of the following iOS UIView.ContentMode (see
  112. # https://developer.apple.com/documentation/uikit/uiview/contentmode): scaleToFill,
  113. # scaleAspectFit, scaleAspectFill, center, top, bottom, left, right, topLeft, topRight,
  114. # bottomLeft, or bottomRight.
  115. #ios_content_mode: center
  116. #
  117. # web_image_mode can be one of the following modes: center, contain, stretch, and cover.
  118. #web_image_mode: center
  119. # The screen orientation can be set in Android with the android_screen_orientation parameter.
  120. # Valid parameters can be found here:
  121. # https://developer.android.com/guide/topics/manifest/activity-element#screen
  122. #android_screen_orientation: sensorLandscape
  123. # To hide the notification bar, use the fullscreen parameter. Has no effect in web since web
  124. # has no notification bar. Defaults to false.
  125. # NOTE: Unlike Android, iOS will not automatically show the notification bar when the app loads.
  126. # To show the notification bar, add the following code to your Flutter app:
  127. # WidgetsFlutterBinding.ensureInitialized();
  128. # SystemChrome.setEnabledSystemUIMode(SystemUiMode.manual, overlays: [SystemUiOverlay.bottom, SystemUiOverlay.top], );
  129. #fullscreen: true
  130. # If you have changed the name(s) of your info.plist file(s), you can specify the filename(s)
  131. # with the info_plist_files parameter. Remove only the # characters in the three lines below,
  132. # do not remove any spaces:
  133. #info_plist_files:
  134. # - 'ios/Runner/Info-Debug.plist'
  135. # - 'ios/Runner/Info-Release.plist'