implement splashscreen support

Author: GregorBiswanger

ElectronNET.CLI/Commands/Actions/DeployEmbeddedElectronFiles.cs

@@ -27,6 +27,13 @@ public static void Do(string tempPath)
             EmbeddedFileHelper.DeployEmbeddedFile(hostApiFolder, "shell.js", "api.");
             EmbeddedFileHelper.DeployEmbeddedFile(hostApiFolder, "screen.js", "api.");
             EmbeddedFileHelper.DeployEmbeddedFile(hostApiFolder, "clipboard.js", "api.");
+
+            string splashscreenFolder = Path.Combine(tempPath, "splashscreen");
+            if (Directory.Exists(splashscreenFolder) == false)
+            {
+                Directory.CreateDirectory(splashscreenFolder);
+            }
+            EmbeddedFileHelper.DeployEmbeddedFile(splashscreenFolder, "index.html", "splashscreen.");
         }
     }
 }

ElectronNET.CLI/ElectronNET.CLI.csproj

@@ -67,6 +67,9 @@ This package contains the dotnet tooling to electronize your application.</Descr
       <EmbeddedResource Include="..\ElectronNET.Host\ElectronHostHook\.gitignore" Link="ElectronHost\ElectronHostHook\.gitignore" />
   </ItemGroup>
 
+  <ItemGroup>
+    <EmbeddedResource Include="..\ElectronNET.Host\splashscreen\index.html" Link="ElectronHost\splashscreen\index.html" />
+  </ItemGroup>
 
   <ItemGroup>
     <EmbeddedResource Include="..\ElectronNET.Host\api\app.js" Link="ElectronHost\api\app.js" />

ElectronNET.Host/electron.manifest.json

@@ -1,5 +1,9 @@
 {
   "executable": "{{executable}}",
+  "splashscreen": {
+    "imageFile": ""
+  },
+  "singleInstance": false,
   "build": {
     "appId": "com.{{executable}}.app",
     "productName": "{{executable}}",

ElectronNET.Host/main.js

@@ -3,6 +3,7 @@ const { BrowserWindow } = require('electron');
 const path = require('path');
 const process = require('child_process').spawn;
 const portscanner = require('portscanner');
+const imageSize = require('image-size');
 let io, server, browserWindows, ipc, apiProcess, loadURL;
 let appApi, menu, dialogApi, notification, tray, webContents;
 let globalShortcut, shellApi, screen, clipboard;
@@ -36,36 +37,49 @@ app.on('ready', () => {
 });
 
 function isSplashScreenEnabled() {
-    return Boolean(manifestJsonFile.loadingUrl);
+    if(manifestJsonFile.hasOwnProperty('splashscreen')) {
+        if(manifestJsonFile.splashscreen.hasOwnProperty('imageFile')) {
+            return  Boolean(manifestJsonFile.splashscreen.imageFile);
+        }
+    }
+
+    return false;
 }
 
 function startSplashScreen() {
-    let loadingUrl = manifestJsonFile.loadingUrl;
-    let icon = manifestJsonFile.icon;
+    let imageFile = path.join(currentBinPath, manifestJsonFile.splashscreen.imageFile);
+    imageSize(imageFile, (error, dimensions) => {
+        if (error) {
+            console.log(`load splashscreen error:`);
+            console.log(error);
+
+            throw new Error(error.message);
+        }
 
-    if (loadingUrl) {
         splashScreen = new BrowserWindow({
-            width: manifestJsonFile.width,
-            height: manifestJsonFile.height,
+            width: dimensions.width,
+            height: dimensions.height,
             transparent: true,
+            center: true,
             frame: false,
-            show: false,
-            icon: path.join(__dirname, icon)
+            alwaysOnTop: true,
+            skipTaskbar: true,
+            show: true
         });
 
-        if (manifestJsonFile.devTools) {
-            splashScreen.webContents.openDevTools();
-        }
-
-        splashScreen.loadURL(loadingUrl);
-        splashScreen.once('ready-to-show', () => {
-            splashScreen.show();
+        app.once('browser-window-focus', () => {
+            app.once('browser-window-focus', () => {
+                splashScreen.destroy();
+            });
         });
 
-        splashScreen.on('closed', () => {
+        const loadSplashscreenUrl = path.join(__dirname, 'splashscreen', 'index.html') + '?imgPath=' + imageFile;
+        splashScreen.loadURL('file://' + loadSplashscreenUrl);
+
+        splashScreen.once('closed', () => {
             splashScreen = null;
         });
-    }
+    });
 }
 
 function startSocketApiBridge(port) {
@@ -101,10 +115,6 @@ function startSocketApiBridge(port) {
         screen = require('./api/screen')(socket);
         clipboard = require('./api/clipboard')(socket);
 
-        if (splashScreen && !splashScreen.isDestroyed()) {
-            splashScreen.close();
-        }
-
         try {
             const hostHookScriptFilePath = path.join(__dirname, 'ElectronHostHook', 'index.js');