@trodi/electron-splashscreen
v1.0.2TypeScript
Simple splashscreen for electron applications
670/weekUpdated 3 years agoMITUnpacked: 10.5 KB
Published by Troy McKinnon
npm install @trodi/electron-splashscreen
electron-splashscreen 
> Simple splashscreen for Electron applications.
Ideally, your application loads instantaneously. However, some applications are larger and/or may be running on a slower machine, causing the load to take longer. If the application is taking a bit to load, electron-splashscreen will appear so the user knows the application is loading, but can't interact with a partially loaded application.
electron-splashscreen is simple to incorporate, while allowing you the freedom to customize with any look, feel, and functionality.
No external dependencies.
Install
``shell`
npm install @trodi/electron-splashscreen
Usage
$3
Example of your Electron browser process.
`typescript${__dirname}/splash-screen.html
// import the module
import * as Splashscreen from "@trodi/electron-splashscreen";
const mainOpts: Electron.BrowserWindowConstructorOptions = ...
// configure the splashscreen
const config: Splashscreen.Config = {
windowOpts: mainOpts;
templateUrl: ;file://index.html
splashScreenOpts: {
width: 425,
height: 325,
},
};
// initialize the splashscreen handling
const main: BrowserWindow = Splashscreen.initSplashScreen(config);
// load your browser window per usual
main.loadURL();`
You can run examples via npm run example and npm run example-dynamic.
API
Build
npm run build
Publish
* npm version
*
* Commit and push changes to git