Capacitor Splash Screen

Cap-go/capgo-skills/plugins/capacitor-features/skills/capacitor-splash-screen

作者 Cap-go2cfb277a148832bdb1a835b01e4de323687b498b无许可证72 个星标收录于 2026年10月9日更新于 2026年10月9日仓库今天更新

Guide to configuring splash screens in Capacitor apps including asset generation, animation, and programmatic control. Use this skill when users need to customize their app launch experience.

AI 生成的概览

指导配置 Capacitor 启动画面,涵盖资源、动画与编程控制。

功能
该技能提供在 Capacitor 应用中为 iOS 和 Android 配置与自定义启动画面的说明。内容涵盖插件安装、配置项、编程式显示与隐藏调用、使用 Capacitor Assets 生成资源、各平台尺寸、iOS storyboard 与 Android XML 设置、深色模式支持以及动画启动画面。还列出了最佳实践与故障排查建议。
适用场景
当用户想要自定义应用启动画面、需要启动画面资源、想要动画启动画面,或在 Capacitor 项目中排查启动画面问题时使用。
运行要求
Capacitor 应用项目;用于安装 @capacitor/splash-screen 及可选 @capacitor/assets 的 Node.js 与 npm;npx cap sync;网页动画启动画面可选 lottie-web。仅为说明文档,不含脚本。

Splash Screen in Capacitor

Configure and customize splash screens for iOS and Android.

When to Use This Skill

  • User wants to customize splash screen
  • User needs splash screen assets
  • User wants animated splash
  • User has splash screen issues

Quick Start

Install Plugin

bash
npm install @capacitor/splash-screennpx cap sync

Basic Configuration

typescript
// capacitor.config.tsimport type { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = {  plugins: {    SplashScreen: {      launchShowDuration: 2000,      launchAutoHide: true,      backgroundColor: '#ffffff',      androidSplashResourceName: 'splash',      androidScaleType: 'CENTER_CROP',      showSpinner: false,      splashFullScreen: true,      splashImmersive: true,    },  },};

Programmatic Control

typescript
import { SplashScreen } from '@capacitor/splash-screen';
// Hide after app is readyasync function initApp() {  // Initialize your app  await loadUserData();  await setupServices();
  // Hide splash screen  await SplashScreen.hide();}
// Show splash (useful for app refresh)await SplashScreen.show({  autoHide: false,});
// Hide with animationawait SplashScreen.hide({  fadeOutDuration: 500,});

Generate Assets

Using Capacitor Assets

bash
npm install -D @capacitor/assets
# Place source images in resources/# resources/splash.png (2732x2732 recommended)# resources/splash-dark.png (optional)
npx capacitor-assets generate

iOS Sizes

SizeUsage
2732x2732iPad Pro 12.9"
2048x2732iPad Pro portrait
2732x2048iPad Pro landscape
1668x2388iPad Pro 11"
1536x2048iPad
1242x2688iPhone XS Max
828x1792iPhone XR
1125x2436iPhone X/XS
1242x2208iPhone Plus
750x1334iPhone 8
640x1136iPhone SE

Android Sizes

DensitySize
mdpi320x480
hdpi480x800
xhdpi720x1280
xxhdpi960x1600
xxxhdpi1280x1920

iOS Storyboard

xml
<!-- ios/App/App/Base.lproj/LaunchScreen.storyboard --><?xml version="1.0" encoding="UTF-8"?><document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0">    <scenes>        <scene sceneID="1">            <objects>                <viewController id="2" sceneMemberID="viewController">                    <view key="view" contentMode="scaleToFill" id="3">                        <rect key="frame" x="0" y="0" width="414" height="896"/>                        <color key="backgroundColor" systemColor="systemBackgroundColor"/>                        <subviews>                            <imageView                                contentMode="scaleAspectFit"                                image="splash"                                translatesAutoresizingMaskIntoConstraints="NO"                                id="4">                            </imageView>                        </subviews>                        <constraints>                            <constraint firstItem="4" firstAttribute="centerX" secondItem="3" secondAttribute="centerX" id="5"/>                            <constraint firstItem="4" firstAttribute="centerY" secondItem="3" secondAttribute="centerY" id="6"/>                        </constraints>                    </view>                </viewController>            </objects>        </scene>    </scenes></document>

Android Configuration

XML Splash Screen (Android 11+)

xml
<!-- android/app/src/main/res/values/styles.xml --><resources>    <style name="AppTheme.NoActionBarLaunch" parent="Theme.SplashScreen">        <item name="windowSplashScreenBackground">@color/splash_background</item>        <item name="windowSplashScreenAnimatedIcon">@drawable/splash</item>        <item name="windowSplashScreenAnimationDuration">1000</item>        <item name="postSplashScreenTheme">@style/AppTheme.NoActionBar</item>    </style></resources>

Colors

xml
<!-- android/app/src/main/res/values/colors.xml --><resources>    <color name="splash_background">#FFFFFF</color></resources>
<!-- android/app/src/main/res/values-night/colors.xml --><resources>    <color name="splash_background">#121212</color></resources>

Dark Mode Support

typescript
// capacitor.config.tsplugins: {  SplashScreen: {    launchAutoHide: false, // Control manually    backgroundColor: '#ffffff',    // iOS will use LaunchScreen.storyboard variations    // Android uses values-night/colors.xml  },},
typescript
// Detect dark mode and configureimport { SplashScreen } from '@capacitor/splash-screen';
const isDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
// Show appropriate themed contentawait SplashScreen.hide({  fadeOutDuration: 300,});

Animated Splash

Lottie Animation

typescript
import { SplashScreen } from '@capacitor/splash-screen';
async function showAnimatedSplash() {  // Keep native splash while loading  await SplashScreen.show({ autoHide: false });
  // Load Lottie animation in web  const lottie = await import('lottie-web');
  // Show web-based animated splash  document.getElementById('splash-animation').style.display = 'block';
  const animation = lottie.loadAnimation({    container: document.getElementById('splash-animation'),    path: '/animations/splash.json',    loop: false,  });
  animation.addEventListener('complete', async () => {    // Hide native splash    await SplashScreen.hide({ fadeOutDuration: 0 });    // Hide web splash    document.getElementById('splash-animation').style.display = 'none';  });}

Best Practices

  1. Keep it fast - Under 2 seconds total
  2. Match branding - Use consistent colors/logo
  3. Support dark mode - Provide dark variants
  4. Don't block - Load essentials only
  5. Progressive reveal - Fade out smoothly

Troubleshooting

IssueSolution
White flashMatch splash background to app
StretchingUse correct asset sizes
Not hidingCall hide() manually
Dark mode wrongAdd values-night resources

Resources

来源与署名

来源:Cap-go/capgo-skills位于plugins/capacitor-features/skills/capacitor-splash-screen提交2cfb277

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架