electron-splashscreen
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

electron-splashscreen

electron-splashscreen
Nice splashscreens for your electronjs app

Build Status Coverage Status Version Language License

Install

Yarn

yarn add electron-splashscreen

NPM

npm i electron-splashscreen

Example

import { initSplashScreen, OfficeTemplate } from 'electron-splashscreen';
import isDev from 'electron-is-dev';
import { resolve } from 'app-root-path';
 
const mainWindow = new BrowserWindow({
  ...
});
 
const hideSplashscreen = initSplashScreen({
  mainWindow,
  icon: isDev ? resolve('assets/icon.ico') : undefined,
  url: OfficeTemplate,
  width: 500,
  height: 300,
  brand: 'My Brand',
  productName: 'My App',
  logo: resolve('assets/logo.svg'),
  website: 'www.my-brand.com',
  text: 'Initializing ...'
});

You can now either within main:

mainWindow.once('ready-to-show', () => {
  mainWindow.show();
  hideSplashscreen();
});

or within renderer

// within renderer
import { reportReady } from 'electron-splashscreen';
// call this whenever your app is ready, for example after all data is loaded
reportReady();

Readme

Keywords

none

Package Sidebar

Install

npm i electron-splashscreen

Weekly Downloads

76

Version

1.0.0

License

MIT

Unpacked Size

53.9 kB

Total Files

52

Last publish

Collaborators

  • bkniffler