feat: SplashScreen Background Color preference support

Closes #1254.
apache · Mar 20, 2024 · e10fd3d · e10fd3d
1 parent c97845a
commit e10fd3d
Show file tree

Hide file tree

Showing 5 changed files with 89 additions and 16 deletions.
diff --git a/CordovaLib/Classes/Public/CDVViewController.m b/CordovaLib/Classes/Public/CDVViewController.m
@@ -294,8 +294,10 @@ - (void)viewDidLoad
     // /////////////////
 
     UIColor* bgColor = [UIColor colorNamed:@"BackgroundColor"] ?: UIColor.whiteColor;
-    [self.launchView setBackgroundColor:bgColor];
     [self.webView setBackgroundColor:bgColor];
+
+    bgColor = [UIColor colorNamed:@"SplashScreenBackgroundColor"] ?: UIColor.whiteColor;
+    [self.launchView setBackgroundColor:bgColor];
 }
 
 -(void)viewWillAppear:(BOOL)animated

diff --git a/lib/prepare.js b/lib/prepare.js
@@ -467,6 +467,21 @@ function getBackgroundColorDir (projectRoot, platformProjDir) {
     }
 }
 
+/**
+ * Returns the directory for the SplashScreenBackgroundColor.colorset asset, or
+ * null if no xcassets exist.
+ *
+ * @param  {string} projectRoot        The project's root directory
+ * @param  {string} platformProjDir    The platform's project directory
+ */
+function getSplashScreenBackgroundColorDir (projectRoot, platformProjDir) {
+    if (folderExists(path.join(projectRoot, platformProjDir, 'Assets.xcassets/'))) {
+        return path.join(platformProjDir, 'Assets.xcassets', 'SplashScreenBackgroundColor.colorset');
+    } else {
+        return null;
+    }
+}
+
 function colorPreferenceToComponents (pref) {
     if (!pref || !pref.match(/^(#[0-9A-Fa-f]{3}|(0x|#)([0-9A-Fa-f]{2})?[0-9A-Fa-f]{6})$/)) {
         return {
@@ -517,11 +532,12 @@ function colorPreferenceToComponents (pref) {
  * @param {Object} locations A dictionary containing useful location paths
  */
 function updateBackgroundColor (cordovaProject, locations) {
+    const platformProjDir = path.relative(cordovaProject.root, locations.xcodeCordovaProj);
+
     const pref = cordovaProject.projectConfig.getPreference('BackgroundColor', 'ios') || '';
+    const splashPref = cordovaProject.projectConfig.getPreference('SplashScreenBackgroundColor', 'ios') || pref;
 
-    const platformProjDir = path.relative(cordovaProject.root, locations.xcodeCordovaProj);
     const backgroundColorDir = getBackgroundColorDir(cordovaProject.root, platformProjDir);
-
     if (backgroundColorDir) {
         const contentsJSON = {
             colors: [{
@@ -538,6 +554,24 @@ function updateBackgroundColor (cordovaProject, locations) {
         fs.writeFileSync(path.join(cordovaProject.root, backgroundColorDir, 'Contents.json'),
             JSON.stringify(contentsJSON, null, 2));
     }
+
+    const splashBackgroundColorDir = getSplashScreenBackgroundColorDir(cordovaProject.root, platformProjDir);
+    if (splashBackgroundColorDir) {
+        const contentsJSON = {
+            colors: [{
+                idiom: 'universal',
+                color: colorPreferenceToComponents(splashPref)
+            }],
+            info: {
+                author: 'Xcode',
+                version: 1
+            }
+        };
+
+        events.emit('verbose', 'Updating Splash Screen Background Color color set Contents.json');
+        fs.writeFileSync(path.join(cordovaProject.root, splashBackgroundColorDir, 'Contents.json'),
+            JSON.stringify(contentsJSON, null, 2));
+    }
 }
 
 /**
@@ -549,24 +583,31 @@ function updateBackgroundColor (cordovaProject, locations) {
  */
 function cleanBackgroundColor (projectRoot, projectConfig, locations) {
     const platformProjDir = path.relative(projectRoot, locations.xcodeCordovaProj);
-    const backgroundColorDir = getBackgroundColorDir(projectRoot, platformProjDir);
 
-    if (backgroundColorDir) {
-        const contentsJSON = {
-            colors: [{
-                idiom: 'universal',
-                color: colorPreferenceToComponents(null)
-            }],
-            info: {
-                author: 'Xcode',
-                version: 1
-            }
-        };
+    const contentsJSON = {
+        colors: [{
+            idiom: 'universal',
+            color: colorPreferenceToComponents(null)
+        }],
+        info: {
+            author: 'Xcode',
+            version: 1
+        }
+    };
 
+    const backgroundColorDir = getBackgroundColorDir(projectRoot, platformProjDir);
+    if (backgroundColorDir) {
         events.emit('verbose', 'Cleaning Background Color color set Contents.json');
         fs.writeFileSync(path.join(projectRoot, backgroundColorDir, 'Contents.json'),
             JSON.stringify(contentsJSON, null, 2));
     }
+
+    const splashBackgroundColorDir = getSplashScreenBackgroundColorDir(projectRoot, platformProjDir);
+    if (splashBackgroundColorDir) {
+        events.emit('verbose', 'Cleaning Splash Screen Background Color color set Contents.json');
+        fs.writeFileSync(path.join(projectRoot, splashBackgroundColorDir, 'Contents.json'),
+            JSON.stringify(contentsJSON, null, 2));
+    }
 }
 
 function updateFileResources (cordovaProject, locations) {

diff --git a/...oject/__PROJECT_NAME__/Assets.xcassets/SplashScreenBackgroundColor.colorset/Contents.json b/...oject/__PROJECT_NAME__/Assets.xcassets/SplashScreenBackgroundColor.colorset/Contents.json
@@ -0,0 +1,15 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "platform" : "ios",
+        "reference" : "systemBackgroundColor"
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}
diff --git a/templates/project/__PROJECT_NAME__/CDVLaunchScreen.storyboard b/templates/project/__PROJECT_NAME__/CDVLaunchScreen.storyboard
@@ -58,7 +58,7 @@
     </scenes>
     <resources>
         <image name="LaunchStoryboard" width="1366" height="1366"/>
-        <namedColor name="BackgroundColor">
+        <namedColor name="SplashScreenBackgroundColor">
             <color white="1" alpha="1" colorSpace="custom" customColorSpace="genericGamma22GrayColorSpace"/>
         </namedColor>
     </resources>

diff --git a/...s-config-xml/SampleApp/Assets.xcassets/SplashScreenBackgroundColor.colorset/Contents.json b/...s-config-xml/SampleApp/Assets.xcassets/SplashScreenBackgroundColor.colorset/Contents.json
@@ -0,0 +1,15 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "platform" : "ios",
+        "reference" : "systemBackgroundColor"
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}