Capacitor Splash Screen banner
aparajita aparajita

Capacitor Splash Screen

Development community

Description

Capacitor 4 plugin that provides full native splash screen functionality

Installation

This entry records only its repository, not the path inside it, so there is no exact command to give. Open the source below and copy the folder into ~/.claude/skills/, or the file into ~/.claude/agents/.

README

capacitor-splash-screen  [![npm version](https://badge.fury.io/js/@aparajita%2Fcapacitor-splash-screen.svg)](https://badge.fury.io/js/@aparajita%2Fcapacitor-splash-screen)

❗️This package is no longer maintained. I don’t have the time to work on it, and now use the official splash screen plugin myself.

This [Capacitor 4](https://capacitorjs.com) plugin is a replacement for the official [Splash Screen plugin](https://capacitorjs.com/docs/apis/splash-screen) and provides complete control over native splash screens, both automatically at launch and via code.

👉 **NOTE:** This plugin does not work with Capacitor < 4.

[About](#about)
[Features](#features)
[Installation](#installation)
[Launch screen configuration](#launch-screen-configuration)
[Usage](#usage)
[Custom animation](#custom-animation)
[API](#api)

About

iOS and Android already provide launch screens, so why do we need this plugin?

System launch screens by default are removed as soon as the first frame is drawn by the application being launched. In the case of an Capacitor app, that occurs when the layout with the web view is drawn. But there is a finite (and often noticeable) delay between the time when the web view is drawn and the time when the app is fully mounted and drawn within the web view.

To prevent the user from seeing a flash of a blank screen after the system launch screen disappears, this plugin allows you to extend the time the system launch screen is displayed until after the app is fully mounted and drawn. In addition, you can modify the fade out duration or alternatively you can provide your own custom code to animate the launch screen using the hooks provided by this plugin.

Changes from v1.x

Whereas v1.x of this plugin supported multiple formats, this version only supports the formats supported by system launch screens. On iOS, that means storyboards; on Android that means vector drawables (or animated vector d