expo-splash-screen/plugin/src/types.ts

Provides a module to allow keeping the native Splash Screen visible until you choose to hide it.

export interface BaseAndroidSplashConfig {
  backgroundColor?: string;
  image?: string;
  mdpi?: string;
  hdpi?: string;
  xhdpi?: string;
  xxhdpi?: string;
  xxxhdpi?: string;
}

export type AndroidSplashConfig = BaseAndroidSplashConfig & {
  backgroundColor: string; // remove optional
  drawable?: { icon: string; darkIcon?: string };
  imageWidth: number;
  resizeMode: 'contain' | 'cover' | 'native';
  dark?: BaseAndroidSplashConfig;
};

export type BaseIOSSplashConfig = {
  backgroundColor?: string;
  image?: string;
  tabletBackgroundColor?: string;
  tabletImage?: string;
};

export type IOSSplashConfig = BaseIOSSplashConfig & {
  backgroundColor: string; // remove optional
  enableFullScreenImage_legacy: boolean;
  imageWidth: number;
  resizeMode: 'cover' | 'contain';
  dark?: BaseIOSSplashConfig;
};

export type Props = {
  /**
   * Hex color for the splash screen background.
   * @default "#ffffff"
   */
  backgroundColor?: string;
  /**
   * The width to make the image.
   * @default 100
   */
  imageWidth?: number;
  /**
   * Whether to use a full screen image as the splash screen. Legacy transition helper, will be removed.
   * @default false
   */
  enableFullScreenImage_legacy?: boolean;
  /**
   * Path to the image displayed on the splash screen.
   */
  image?: string;
  /**
   * How the image is scaled. Accepts `contain`, `cover`, `native`.
   * @default "contain"
   */
  resizeMode?: 'contain' | 'cover' | 'native';
  /**
   * Properties for configuring the splash screen in dark mode.
   */
  dark?: {
    image?: string;
    backgroundColor?: string;
  };
  /**
   * Properties for configuring the splash screen on Android.
   * @platform android
   */
  android?: Partial<AndroidSplashConfig>;
  /**
   * Properties for configuring the splash screen on iOS.
   * @platform ios
   */
  ios?: Partial<IOSSplashConfig>;
};