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

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

import { AndroidSplashConfig } from '@expo/prebuild-config/build/plugins/unversioned/expo-splash-screen/getAndroidSplashConfig';
import { IOSSplashConfig } from '@expo/prebuild-config/build/plugins/unversioned/expo-splash-screen/getIosSplashConfig';
import { withAndroidSplashScreen } from '@expo/prebuild-config/build/plugins/unversioned/expo-splash-screen/withAndroidSplashScreen';
import { withIosSplashScreen } from '@expo/prebuild-config/build/plugins/unversioned/expo-splash-screen/withIosSplashScreen';
import { ConfigPlugin, createRunOncePlugin } from 'expo/config-plugins';

const pkg = require('expo-splash-screen/package.json');

type PluginConfig = {
  backgroundColor: string;
  imageWidth?: number;
  enableFullScreenImage_legacy?: boolean;
  image?: string;
  resizeMode?: 'contain' | 'cover' | 'native';
  dark?: {
    image?: string;
    backgroundColor?: string;
  };
  android?: AndroidSplashConfig;
  ios?: IOSSplashConfig;
};

const withSplashScreen: ConfigPlugin<PluginConfig | null> = (config, props) => {
  if (!props) {
    config = withAndroidSplashScreen(config, null);
    config = withIosSplashScreen(config, null);
    return config;
  }

  const resizeMode = props?.resizeMode || 'contain';

  const { ios: iosProps, android: androidProps, ...otherProps } = props;

  const android: AndroidSplashConfig = {
    ...otherProps,
    ...androidProps,
    resizeMode: androidProps?.resizeMode || resizeMode,
    dark: {
      ...otherProps?.dark,
      ...androidProps?.dark,
    },
  };
  const ios: IOSSplashConfig = {
    ...otherProps,
    ...iosProps,
    resizeMode: iosProps?.resizeMode || (resizeMode === 'native' ? 'contain' : resizeMode),
    dark: {
      ...otherProps?.dark,
      ...iosProps?.dark,
    },
  };

  // Need to pass null here if we don't receive any props. This means that the plugin has not been used.
  // This only happens on Android. On iOS, if you don't use the plugin, this function won't be called.
  config = withAndroidSplashScreen(config, android);
  config = withIosSplashScreen(config, ios);
  return config;
};

export default createRunOncePlugin(withSplashScreen, pkg.name, pkg.version);