stewones / electron Goto Github PK

Capacitor community support for the Electron platform.

Maintenance Status: Actively Maintained

Doc: Class usage and config options

Doc: Create a plugin for the Electron platform

1. Build your webapp in your capacitor initiated project.
2. Run npm i @capacitor-community/electron in your webapp project directory. This will install the platform and its dependancies along with placing a copy of your built webapp into the platform folder electron
3. Open a terminal in the electron platform folder and run npm run electron:start to start your app with the default config.

@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 createCapacitorElectronApp(config). For example if your image was named myImage.gif (yes animated GIF's are valid) you would pass it like this:

  import {app, ......} from 'electron';
  import * as path from 'path';

  .....

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

• 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.

Max Lynch 💻 📖

Mike S 💻 📖

Daniel Sogl 💻

Hervé de CHAVIGNY 💻 📖