版本：v8

@capacitor/splash-screen

Splash Screen API 提供了显示或隐藏启动图像的方法。

安装

npm install @capacitor/splash-screen
npx cap sync

Android 12 启动屏 API

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

Capacitor 4 使用 Android 12 启动屏 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 启动屏 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 问题跟踪器 Google 问题跟踪器 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，且在使用 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，则配置对话框布局。如果未设置 `useDialog` 或为 false，则使用布局而不是 ImageView。在启动时使用 Android 12 API 时不生效。仅适用于 Android。		1.1.0
`useDialog`	`boolean`	是否使用对话框而不是 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.0.1）

示例指南

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

为 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

Interfaces

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 启动屏 API​

示例​

隐藏启动屏​

背景颜色​

加载指示器​

配置​

示例​

Android​

变量​

示例指南​

API​

show(...)​

hide(...)​

Interfaces​

ShowOptions​

HideOptions​

Contents

安装

Android 12 启动屏 API

示例

隐藏启动屏

背景颜色

加载指示器

配置

示例

Android

变量

示例指南

API

show(...)

hide(...)

Interfaces

ShowOptions

HideOptions