版本：v8

@capacitor/splash-screen

Splash Screen API 提供显示或隐藏启动画面的方法。

安装

npm install @capacitor/splash-screen
npx cap sync

Android 12 Splash Screen API

这只影响启动时的启动画面，在使用编程式 show() 方法时不会生效。

Capacitor 4 使用 Android 12 Splash Screen API 和 androidx.core:core-splashscreen 兼容库，使其在 Android 11 及更低版本上工作。

可以通过将 android/app/src/main/res/values/styles.xml 文件中 AppTheme.NoActionBarLaunch 的父主题从 Theme.SplashScreen 改为 AppTheme.NoActionBar 来禁用兼容库。 Android 12+ 上的 Android 12 Splash Screen API 无法禁用，因为它是 Android 操作系统的一部分。

<style name="AppTheme.NoActionBarLaunch" parent="AppTheme.NoActionBar">
    <item name="android:background">@drawable/splash</item>
</style>

注意：在 Android 12 和 Android 12L 设备上，当从第三方启动器（如 Nova Launcher、MIUI、Realme Launcher、OPPO Launcher 等）、设置应用中的应用信息页面或 Android Studio 等 IDE 启动时，启动画面可能不会显示。 Google Issue Tracker Google Issue Tracker Google 已在 Android 13 上修复了这些问题，但不会向后移植到 Android 12 和 Android 12L。启动器相关的问题可能会通过启动器更新得到解决。如果您仍然在 Android 13 上发现与启动画面相关的问题，请向 Google 报告。

示例

import { SplashScreen } from '@capacitor/splash-screen';

// 隐藏启动画面（应在应用启动时执行）
await SplashScreen.hide();

// 无限期地显示启动画面：
await SplashScreen.show({
  autoHide: false,
});

// 显示启动画面两秒，然后自动隐藏：
await SplashScreen.show({
  showDuration: 2000,
  autoHide: true,
});

隐藏启动画面

默认情况下，启动画面会在 500 毫秒后自动隐藏。

如果您希望确保启动画面在应用准备就绪前永不消失，请将 launchAutoHide 设置为 false；这样启动画面将保持可见，直到手动隐藏。为了获得最佳用户体验，您的应用应尽快调用 hide()。

相反，如果您希望固定显示启动画面一段时间，请在您的 Capacitor 配置文件中设置 launchShowDuration。

背景色

在某些情况下，特别是当启动画面没有完全覆盖设备屏幕时，应用屏幕可能会在边角处可见（由于透明度）。为了避免显示透明色，您可以设置 backgroundColor 来覆盖这些区域。

backgroundColor 的可能值可以是 #RRGGBB 或 #RRGGBBAA。

加载指示器

如果您希望在启动画面上方显示一个加载指示器，请在您的 Capacitor 配置文件中将 showSpinner 设置为 true。

您可以通过以下配置自定义加载指示器的外观。

对于 Android，androidSpinnerStyle 有以下选项：

horizontal
small
large（默认）
inverse
smallInverse
largeInverse

对于 iOS，iosSpinnerStyle 有以下选项：

large（默认）
small

要设置加载指示器的颜色，请使用 spinnerColor，值可以是 #RRGGBB 或 #RRGGBBAA。## 配置

以下是可用的配置值：

属性	类型	描述	默认值	自版本
`launchShowDuration`	`number`	当启用 autoHide 时，启动闪屏的显示时长（单位：毫秒）	`500`	1.0.0
`launchAutoHide`	`boolean`	是否在 launchShowDuration 后自动隐藏启动闪屏。	`true`	1.0.0
`launchFadeOutDuration`	`number`	启动闪屏淡出动画的持续时间（单位：毫秒）仅适用于 Android 12 启动闪屏 API。	`200`	4.2.0
`backgroundColor`	`string`	闪屏背景色，使用十六进制格式，如 #RRGGBB 或 #RRGGBBAA。当 `useDialog` 为 true 或在启动时使用 Android 12 API 时无效。		1.0.0
`androidSplashResourceName`	`string`	用作闪屏的资源名称。在启动时使用 Android 12 API 时无效。仅适用于 Android。	`splash`	1.0.0
`androidScaleType`	`'CENTER' \| 'CENTER_CROP' \| 'CENTER_INSIDE' \| 'FIT_CENTER' \| 'FIT_END' \| 'FIT_START' \| 'FIT_XY' \| 'MATRIX'`	用于缩放闪屏图像的 ImageView.ScaleType。当 `useDialog` 为 true 或在启动时使用 Android 12 API 时无效。仅适用于 Android。	`FIT_XY`	1.0.0
`showSpinner`	`boolean`	在闪屏上显示加载指示器。当 `useDialog` 为 true 或在启动时使用 Android 12 API 时无效。		1.0.0
`androidSpinnerStyle`	`'horizontal' \| 'small' \| 'large' \| 'inverse' \| 'smallInverse' \| 'largeInverse'`	Android 指示器的样式。当 `useDialog` 为 true 或在启动时使用 Android 12 API 时无效。	`large`	1.0.0
`iosSpinnerStyle`	`'small' \| 'large'`	iOS 指示器的样式。当 `useDialog` 为 true 时无效。仅适用于 iOS。	`large`	1.0.0
`spinnerColor`	`string`	指示器的颜色，使用十六进制格式，如 #RRGGBB 或 #RRGGBBAA。当 `useDialog` 为 true 或在启动时使用 Android 12 API 时无效。		1.0.0
`splashFullScreen`	`boolean`	在闪屏上隐藏状态栏。在启动时使用 Android 12 API 时无效。仅适用于 Android。		1.0.0
`splashImmersive`	`boolean`	在闪屏上隐藏状态栏和软件导航按钮。在启动时使用 Android 12 API 时无效。仅适用于 Android。		1.0.0
`layoutName`	`string`	如果 `useDialog` 设置为 true，则配置 Dialog 布局。如果 `useDialog` 未设置或为 false，则使用布局而非 ImageView。在启动时使用 Android 12 API 时无效。仅适用于 Android。		1.1.0
`useDialog`	`boolean`	使用 Dialog 而非 ImageView。如果未配置 `layoutName`，将使用以闪屏图像为背景的布局。在启动时使用 Android 12 API 时无效。仅适用于 Android。		1.1.0
### 示例

在 capacitor.config.json 文件中：

{
  "plugins": {
    "SplashScreen": {
      "launchShowDuration": 3000,
      "launchAutoHide": true,
      "launchFadeOutDuration": 3000,
      "backgroundColor": "#ffffffff",
      "androidSplashResourceName": "splash",
      "androidScaleType": "CENTER_CROP",
      "showSpinner": true,
      "androidSpinnerStyle": "large",
      "iosSpinnerStyle": "small",
      "spinnerColor": "#999999",
      "splashFullScreen": true,
      "splashImmersive": true,
      "layoutName": "launch_screen",
      "useDialog": true
    }
  }
}

在 capacitor.config.ts 文件中：

/// <reference types="@capacitor/splash-screen" />

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    SplashScreen: {
      launchShowDuration: 3000,
      launchAutoHide: true,
      launchFadeOutDuration: 3000,
      backgroundColor: "#ffffffff",
      androidSplashResourceName: "splash",
      androidScaleType: "CENTER_CROP",
      showSpinner: true,
      androidSpinnerStyle: "large",
      iosSpinnerStyle: "small",
      spinnerColor: "#999999",
      splashFullScreen: true,
      splashImmersive: true,
      layoutName: "launch_screen",
      useDialog: true,
    },
  },
};

export default config;

Android

如果启动图片的名称不是 splash.png，请将 androidSplashResourceName 设置为新的资源名称。此外，在 android/app/src/main/res/values/styles.xml 文件中，修改以下代码块中的资源名称：

<style name="AppTheme.NoActionBarLaunch" parent="AppTheme.NoActionBar">
    <item name="android:background">@drawable/NAME</item>
</style>

变量

本插件将使用以下项目变量（定义在应用的 variables.gradle 文件中）：

coreSplashScreenVersion：androidx.core:core-splashscreen 的版本（默认：1.2.0）

示例指南

添加自定义图标和启动屏幕图片 ›

为 Capacitor 创建动态/自适应启动屏幕（Android） ›

show(...)

show(options?: ShowOptions | undefined) => Promise<void>

显示启动屏幕

参数	类型
`options`	`ShowOptions`

自： 1.0.0

hide(...)

hide(options?: HideOptions | undefined) => Promise<void>

隐藏启动屏幕

参数	类型
`options`	`HideOptions`

自： 1.0.0

接口

ShowOptions

属性	类型	描述	默认值	自
`autoHide`	`boolean`	是否在 showDuration 后自动隐藏启动屏幕		1.0.0
`fadeInDuration`	`number`	淡入持续时间（毫秒）	`200`	1.0.0
`fadeOutDuration`	`number`	淡出持续时间（毫秒）	`200`	1.0.0
`showDuration`	`number`	当 autoHide 启用时，启动屏幕的显示时间（毫秒）	`3000`	1.0.0

HideOptions

属性	类型	描述	默认值	自
`fadeOutDuration`	`number`	淡出持续时间（毫秒）。在 Android 上，如果使用 Android 12 启动屏幕 API，此设置无效，请改用 launchFadeOutDuration 配置项。	`200`	1.0.0

安装​

Android 12 Splash Screen API​

示例​

隐藏启动画面​

背景色​

加载指示器​

Android​

变量​

示例指南​

API​

show(...)​

hide(...)​

接口​

ShowOptions​

HideOptions​

Contents

安装