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

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

import { ConfigPlugin, IOSConfig, withXcodeProject, type XcodeProject } from 'expo/config-plugins';
import path from 'path';

import { STORYBOARD_FILE_PATH } from './withIosSplashScreenStoryboard';

export const withIosSplashXcodeProject: ConfigPlugin = (config) => {
  return withXcodeProject(config, async (config) => {
    config.modResults = await setSplashStoryboardAsync({
      projectName: config.modRequest.projectName!,
      project: config.modResults,
    });
    return config;
  });
};

/**
 * Modifies `.pbxproj` by:
 * - adding reference for `.storyboard` file
 */
export async function setSplashStoryboardAsync({
  projectName,
  project,
}: {
  projectName: string;
  project: XcodeProject;
}): Promise<XcodeProject> {
  // Check if `${projectName}/SplashScreen.storyboard` already exists
  // Path relative to `ios` directory
  const storyboardFilePath = path.join(projectName, STORYBOARD_FILE_PATH);
  if (!project.hasFile(storyboardFilePath)) {
    IOSConfig.XcodeUtils.addResourceFileToGroup({
      filepath: storyboardFilePath,
      groupName: projectName,
      project,
    });
  }

  return project;
}