版本：v4

@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 及更高版本无法禁用此 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 12 启动画面 API 的 Android 设备上可用。	`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:$coreSplashScreenVersion 的版本（默认：1.0.0-rc01）

示例指南

添加自定义图标和启动画面图片 ›

为 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