Electron Binaries

Install

Install in your local project

npm install --save-dev @midion/electron

Install globally

npm install -g @midion/electron

Usage

Please, refer to the official electron documentation.

Simple example

import { app, BrowserWindow } from "electron";
import path from "path";
import url from "url";

const DARWIN = process.platform === "darwin";

function initApp () {
    // Keep a global reference of the window object, if you don't, the window will
    // be closed automatically when the JavaScript object is garbage collected.

    if (global.mainWindow) return;

    // Create the browser window.
    global.mainWindow = new BrowserWindow({ width: 400, height: 600 });

    // Emitted when the window is closed.
    global.mainWindow.on("closed", function() {
        // Dereference the window object, usually you would store windows
        // in an array if your app supports multi windows, this is the time
        // when you should delete the corresponding element.
        global.mainWindow = null;
    });

    // and load the index.html of the app.
    global.mainWindow.loadURL(url.format({
        pathname: path.join(__dirname, "../webapp/main.html"),
        protocol: "file:",
        query: { s: 4 }, // url params here
        slashes: true
    }));


    // Open the DevTools.
    //global.mainWindow.webContents.openDevTools();
}

// This method will be called when Electron has finished
// initialization and is ready to create browser windows.
// Some APIs can only be used after this event occurs.
app.on("ready", initApp);

// Quit when all windows are closed.
app.on("window-all-closed", function () {
    // On OS X it is common for applications and their menu bar
    // to stay active until the user quits explicitly with Cmd + Q
    !DARWIN && app.quit();
});

// On OS X it's common to re-create a window in the app when the
// dock icon is clicked and there are no other windows open.
app.on("activate", initApp);

Maintainers

| | |------------------------------| | Willian Balmant |