DISCLAIMER: This platform is currently in a preview state for installation and will be supported through the Capacitor CLI in an upcomming release of Capacitor.
Capacitor community support for the Electron platform.
Maintainer | GitHub | Social | Sponsoring Company | Primary |
---|---|---|---|---|
Mike Summerfeldt | IT-MikeS | @IT_MikeS | Volunteer | Yes |
Maintenance Status: Actively Maintained
Doc: Class usage and config options
Doc: Create a plugin for the Electron platform
- Build your webapp in your capacitor initiated project.
- 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 folderelectron
- Open a terminal in the
electron
platform folder and runnpm 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:
- Editing the
splash.png
file directly. - Place your own image file into the
assets
folder and pass theimageFilePath
property as part ofsplashScreen -> splashOptions
intocreateCapacitorElectronApp(config)
. For example if your image was namedmyImage.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 π» π |