number | How long to show the launch splash screen when autoHide is enabled (in ms) | 500 | 1.0.0 |
+| **`launchAutoHide`** | boolean | Whether to auto hide the splash after launchShowDuration. | true | 1.0.0 |
+| **`launchFadeOutDuration`** | number | Duration for the fade out animation of the launch splash screen (in ms) Only available for Android, when using the Android 12 Splash Screen API. | 200 | 4.2.0 |
+| **`backgroundColor`** | string | Color of the background of the Splash Screen in hex format, #RRGGBB or #RRGGBBAA. Doesn't work if `useDialog` is true or on launch when using the Android 12 API. | | 1.0.0 |
+| **`androidSplashResourceName`** | string | Name of the resource to be used as Splash Screen. Doesn't work on launch when using the Android 12 API. Only available on Android. | splash | 1.0.0 |
+| **`androidScaleType`** | 'CENTER' \| 'CENTER_CROP' \| 'CENTER_INSIDE' \| 'FIT_CENTER' \| 'FIT_END' \| 'FIT_START' \| 'FIT_XY' \| 'MATRIX' | The [ImageView.ScaleType](https://developer.android.com/reference/android/widget/ImageView.ScaleType) used to scale the Splash Screen image. Doesn't work if `useDialog` is true or on launch when using the Android 12 API. Only available on Android. | FIT_XY | 1.0.0 |
+| **`showSpinner`** | boolean | Show a loading spinner on the Splash Screen. Doesn't work if `useDialog` is true or on launch when using the Android 12 API. | | 1.0.0 |
+| **`androidSpinnerStyle`** | 'horizontal' \| 'small' \| 'large' \| 'inverse' \| 'smallInverse' \| 'largeInverse' | Style of the Android spinner. Doesn't work if `useDialog` is true or on launch when using the Android 12 API. | large | 1.0.0 |
+| **`iosSpinnerStyle`** | 'small' \| 'large' | Style of the iOS spinner. Doesn't work if `useDialog` is true. Only available on iOS. | large | 1.0.0 |
+| **`spinnerColor`** | string | Color of the spinner in hex format, #RRGGBB or #RRGGBBAA. Doesn't work if `useDialog` is true or on launch when using the Android 12 API. | | 1.0.0 |
+| **`splashFullScreen`** | boolean | Hide the status bar on the Splash Screen. Doesn't work on launch when using the Android 12 API. Only available on Android. | | 1.0.0 |
+| **`splashImmersive`** | boolean | Hide the status bar and the software navigation buttons on the Splash Screen. Doesn't work on launch when using the Android 12 API. Only available on Android. | | 1.0.0 |
+| **`layoutName`** | string | If `useDialog` is set to true, configure the Dialog layout. If `useDialog` is not set or false, use a layout instead of the ImageView. Doesn't work on launch when using the Android 12 API. Only available on Android. | | 1.1.0 |
+| **`useDialog`** | boolean | Use a Dialog instead of an ImageView. If `layoutName` is not configured, it will use a layout that uses the splash image as background. Doesn't work on launch when using the Android 12 API. Only available on Android. | | 1.1.0 |
+
+### Examples
+
+In `capacitor.config.json`:
+
+```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
+ }
+ }
+}
+```
+
+In `capacitor.config.ts`:
+
+```ts
+/// ShowOptions |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### hide(...)
+
+```typescript
+hide(options?: HideOptions | undefined) => PromiseHideOptions |
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### ShowOptions
+
+| Prop | Type | Description | Default | Since |
+| --------------------- | -------------------- | ------------------------------------------------------------------- | ----------------- | ----- |
+| **`autoHide`** | boolean | Whether to auto hide the splash after showDuration | | 1.0.0 |
+| **`fadeInDuration`** | number | How long (in ms) to fade in. | 200 | 1.0.0 |
+| **`fadeOutDuration`** | number | How long (in ms) to fade out. | 200 | 1.0.0 |
+| **`showDuration`** | number | How long to show the splash screen when autoHide is enabled (in ms) | 3000 | 1.0.0 |
+
+
+#### HideOptions
+
+| Prop | Type | Description | Default | Since |
+| --------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ----- |
+| **`fadeOutDuration`** | number | How long (in ms) to fade out. On Android, if using the Android 12 Splash Screen API, it's not being used. Use launchFadeOutDuration configuration option instead. | 200 | 1.0.0 |
+
+{ key: BottomSheetKeys; globalJson: string; } |
+
+--------------------
+
+
+### release(...)
+
+```typescript
+release(options: { key: BottomSheetKeys | '*'; }) => Promise{ key: BottomSheetKeys \| '*'; } |
+
+--------------------
+
+
+### openSelf(...)
+
+```typescript
+openSelf(options: { key: BottomSheetKeys; height: string; backgroundColor: string; }) => Promise{ key: BottomSheetKeys; height: string; backgroundColor: string; } |
+
+--------------------
+
+
+### closeSelf(...)
+
+```typescript
+closeSelf(options: { key: BottomSheetKeys; }) => Promise{ key: BottomSheetKeys; } |
+
+--------------------
+
+
+### setSelfSize(...)
+
+```typescript
+setSelfSize(options: { size: 'half' | 'full'; }) => Promise{ size: 'half' \| 'full'; } |
+
+--------------------
+
+
+### callActionInMain(...)
+
+```typescript
+callActionInMain(options: { name: string; optionsJson: string; }) => Promise{ name: string; optionsJson: string; } |
+
+--------------------
+
+
+### callActionInNative(...)
+
+```typescript
+callActionInNative(options: { name: string; optionsJson: string; }) => Promise{ name: string; optionsJson: string; } |
+
+--------------------
+
+
+### openInMain(...)
+
+```typescript
+openInMain(options: { key: BottomSheetKeys; }) => Promise{ key: BottomSheetKeys; } |
+
+--------------------
+
+
+### addListener('delegate', ...)
+
+```typescript
+addListener(eventName: 'delegate', handler: (options: { key: BottomSheetKeys; globalJson: string; }) => void) => Promise'delegate' |
+| **`handler`** | (options: { key: BottomSheetKeys; globalJson: string; }) => void |
+
+**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
+
+--------------------
+
+
+### addListener('move', ...)
+
+```typescript
+addListener(eventName: 'move', handler: () => void) => Promise'move' |
+| **`handler`** | () => void |
+
+**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
+
+--------------------
+
+
+### addListener('callActionInMain', ...)
+
+```typescript
+addListener(eventName: 'callActionInMain', handler: (options: { name: string; optionsJson: string; }) => void) => Promise'callActionInMain' |
+| **`handler`** | (options: { name: string; optionsJson: string; }) => void |
+
+**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
+
+--------------------
+
+
+### addListener('callActionInNative', ...)
+
+```typescript
+addListener(eventName: 'callActionInNative', handler: (options: { name: string; optionsJson: string; }) => void) => Promise'callActionInNative' |
+| **`handler`** | (options: { name: string; optionsJson: string; }) => void |
+
+**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
+
+--------------------
+
+
+### addListener('openInMain', ...)
+
+```typescript
+addListener(eventName: 'openInMain', handler: (options: { key: BottomSheetKeys; }) => void) => Promise'openInMain' |
+| **`handler`** | (options: { key: BottomSheetKeys; }) => void |
+
+**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
+
+--------------------
+
+
+### Interfaces
+
+
+#### PluginListenerHandle
+
+| Prop | Type |
+| ------------ | ----------------------------------------- |
+| **`remove`** | () => Promise<void> |
+
+
+### Type Aliases
+
+
+#### BottomSheetKeys
+
+'initial' | 'receive' | 'invoice' | 'transfer' | 'swap' | 'stake' | 'unstake' | 'staking-info' | 'transaction-info' | 'swap-activity' | 'backup' | 'add-account' | 'settings' | 'qr-scanner' | 'dapp-connect' | 'dapp-transaction' | 'disclaimer' | 'backup-warning'
+
+{renderText(lang('$auth_backup_warning_notice'))}
+