Skip to main content

Splashscreen

Custom splashscreen configuration for universal apps. Control the duration, background color, and custom icon to provide a branded app launch experience.

⚙️ Configuration

📱 Preview

Catalyst Logo
💻 Generated Configuration
{
  "splashScreen": {
    "duration": 1000,
    "backgroundColor": "#ffffff"
  }
}

Configuration​

The splashscreen is configured through the splashScreen object in your app configuration:

{
  "splashScreen": {
    "duration": 1000,
    "backgroundColor": "#ffffff"
  }
}

Custom Icon​

Place your custom splashscreen icon at public/splashscreen.jpg. Supported file extensions:

  • .png
  • .jpg
  • .jpeg
  • .gif
  • .bmp
  • .svg
  • .webp

Behavior​

Default Behavior​

  • No Configuration: Default Android splashscreen is shown
  • No Custom Icon: Fallback Catalyst logo is displayed
  • With Configuration: Custom splashscreen with specified duration and background

Configuration Options​

Duration​

Controls how long the splashscreen is displayed:

{
  "splashScreen": {
    "duration": 2000
  }
}
  • Range: 500ms - 5000ms
  • Default: 1000ms (1 second)
  • Unit: Milliseconds

Background Color​

Sets the background color of the splashscreen:

{
  "splashScreen": {
    "backgroundColor": "#2196F3"
  }
}
  • Format: Hex color code (e.g., #ffffff, #2196F3)
  • Default: #ffffff (white)
  • Transparency: Not supported, use solid colors only

Implementation Notes​

  • Configuration is required to enable custom splashscreen
  • Without configuration, the default Android splashscreen is used
  • Custom icon at public/splashscreen.jpg is automatically detected
  • Fallback Catalyst logo is shown if configuration exists but no custom icon is found
  • Background color applies to the entire screen, not just behind the icon