@capacitor-community/electron-core v1.2.3

Capacitor Electron

Capacitor community support for the Electron platform.

Maintainers

Maintenance Status: Actively Maintained

Docs:

• Typedoc Docs about config and usage options.

Basic Usage Steps:

1. Run npx cap add electron in your project directory.
2. Open a terminal in the electron folder that was created in your project directory and run npm run electron:start to start your app with the default config.

Using your own image for the Splash Screen

@capacitor-community/electron looks in the YOUR_APP_ROOT/electron/assets folder for a splash.png file by default, but you can use your own image by using one of the following methods:

1. Editing the splash.png file directly.
2. Place your own image file into the assets folder and pass the imageFilePath property as part of splashScreen -> splashOptions into CapacitorElectronApp(). For example if your image was named myImage.gif (yes animated GIF's are valid) you would pass it like this:

  const {app, ......} = require('electron');
  const path = require('path');

  .....

  const myCapacitorApp = new CapacitorElectronApp({
    splashScreen: {
      splashOptions: {
        imageFilePath: path.join(app.getAppPath(), "assets", "myImage.gif")
      }
    }
  });

Great electron packages to consider for your project.

• Electron-Unhandled: Catch unhandled errors and promise rejections in your Electron app.
• Electron-Timber: Pretty console logger for Electron apps.
• Electron-Util: Useful utilities for Electron apps and modules.
• Electron-Debug: Adds useful debug features to your Electron app.
• Devtron: An open source tool to help you inspect, monitor, and debug your Electron app.
• Electron-Better-IPC: Simplified IPC communication for Electron apps.
• Electron-Store: Simple data persistence for your Electron app - Save and load user preferences, app state, cache, etc

And more can be found on the Awesome Electron List.