antonymarion / electron-splashscreen

electron-splashscreen

Nice splashscreens for your electronjs app

Install

Yarn

yarn add electron-splashscreen

NPM

npm i electron-splashscreen

Example

import { initSplashScreen, Office } from 'electron-splashscreen';
import isDev from 'electron-is-dev';
import { resolve } from 'app-root-path';

app.on('ready', async () => {
  const mainWindow = new BrowserWindow({
    ...
  });

  const hideSplashscreen = initSplashScreen({
    mainWindow,
    icon: isDev ? resolve('assets/icon.ico') : undefined,
    url: Office,
    width: 500,
    height: 300,
    brand: 'My Brand',
    productName: 'My App',
    logo: resolve('assets/logo.svg'),
    website: 'www.my-brand.com',
    text: 'Initializing ...'
  });

  // send an ipcRenderer.send('ready') from your browser as soon as the app is ready
  ipcMain.on('ready', hideSplashscreen);

  mainWindow.once('ready-to-show', () => {
    // Electron-splash will automatically show the mainwindow as soon, but you can show it earlier in dev
    if (isDev) {
      mainWindow.show();
    }
  });
})