关于electron:Electron-在主进程内可用的模块

上面是 Electron 中主过程可用的模块：

app模块

app 模块是为了管制整个利用的生命周期设计的。

示例：

例如在最初一个窗口被敞开时退出利用：

const app = require('app');app.on('window-all-closed', function(){    app.quit();});

app 对象能够收回以下事件：

autoUpdater模块

autoUpdater 模块提供了一个到 Squirrel 自动更新框架的接口。

autoUpdater 对象会触发以下的事件：

BrowserWindow模块

BrowserWindow 模块用于创立一个新的浏览器窗口。

示例：

// 在主过程中const BrowserWindow = require('electron').BrowserWindow;// 在渲染过程中const BrowserWindow = require('electron').remote.BrowserWindow;var win = new BrowserWindow({ width: 800, height: 400, show: false });win.on('closed', function() {  win = null;});win.loadURL('https://github.com');win.show();

BrowserWindow 对象可触发下列事件：

contentTracing模块

contentTracing 模块用来收集底层的 Chromium 内容模块产生的搜寻数据，这个模块不具备 web 接口，所以须要咱们在 chrome 浏览器中增加 chrome://tracing/ 来加载生成文件从而查看后果。

示例：

const contentTracing = require('contentTracing').;const options = {  categoryFilter: '*',  traceOptions: 'record-until-full,enable-sampling'}contentTracing.startRecording(options, function() {  console.log('Tracing started');  setTimeout(function() {    contentTracing.stopRecording('', function(path) {      console.log('Tracing data recorded to ' + path);    });  }, 3000);});

content-tracing 模块的办法如下：

dialog模块

dialog 模块提供了api 来展现原生的零碎对话框，例如关上文件框或 alert 框。所以 web 利用能够给用户带来跟零碎利用雷同的体验。

示例：

对话框例子，展现了抉择文件和目录：

var win = ...;  // 显示对话框的浏览器窗口const dialog = require('electron').dialog;console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]}));

global-shortcut模块

global-shortcut 模块用于设置各种自定义操作的快捷键。留神应用此模块注册的快捷键是零碎全局的，不要在利用模块响应 ready 音讯前应用此模块。

示例：

var app = require('app');var globalShortcut = require('electron').globalShortcut;app.on('ready', function() {  // 注册一个'ctrl+x'快捷方式  var ret = globalShortcut.register('ctrl+x', function() {    console.log('ctrl+x is pressed');  })  if (!ret) {    console.log('registration failed');  }  // 查看是否注册了'ctrl+x'快捷方式  console.log(globalShortcut.isRegistered('ctrl+x'));});app.on('will-quit', function() {  // 登记'ctrl+x'快捷方式  globalShortcut.unregister('ctrl+x');  // 登记所有快捷方式  globalShortcut.unregisterAll();});

ipcMain模块

ipcMain 模块是类 EventEmitter 的实例，当在主过程中应用它的时候，它管制着由渲染过程发送过去的异步或同步音讯，从渲染过程发送过去的音讯将触发事件。

示例：

上面是一个在主过程和渲染过程之间发送和解决音讯的实例。

主过程：

const ipcMain = require('electron').ipcMain;ipcMain.on('asynchronous-message', function(event, arg) {  console.log(arg);  // 输入ping  event.sender.send('asynchronous-reply', 'pong');});ipcMain.on('synchronous-message', function(event, arg) {  console.log(arg);  //  输入ping  event.returnValue = 'pong';});

渲染过程：

const ipcRenderer = require('electron').ipcRenderer;console.log(ipcRenderer.sendSync('synchronous-message', 'ping')); // 输入pongipcRenderer.on('asynchronous-reply', function(event, arg) {  console.log(arg); // 输入pong});ipcRenderer.send('asynchronous-message', 'ping');

menu模块

menu 模块能够用来创立原生菜单，它可用作利用菜单和内容菜单。

示例：

创立一个新菜单的语法：

var menu = new Menu();

MenuItem模块

MenuItem 模块用来往菜单中增加菜单子项。

示例：

创立一个新的 MenuItem 的语法：

var menuItem = new MenuItem(options)

options 的选项如下所示：

• click
• role
• type
• label
• sublabel
• accelerator
• icon
• enabled
• visible
• checked
• submenu
• id
• position

powerMonitor模块

powerMonitor 模块是用来监听能源区扭转的，只能在主过程中应用。在 app 模块的 ready 事件触发之后就不能应用这个模块了。

示例：

app.on('ready', function() {  require('electron').powerMonitor.on('suspend', function() {    console.log('零碎将进入休眠状态');  });});

powerMonitor 对象会触发以下的事件：

powerSaveBlocker模块

powerSaveBlocker 模块是用来阻止利用零碎进入睡眠模式的，因而这容许利用放弃零碎和屏幕持续工作。

示例：

const powerSaveBlocker = require('electron').powerSaveBlocker;var id = powerSaveBlocker.start('prevent-display-sleep');console.log(powerSaveBlocker.isStarted(id));powerSaveBlocker.stop(id);

powerMonitor 模块有如下办法：

protocol模块

protocol 模块能够注册一个自定义协定，或者应用一个曾经存在的协定。这个模块只有在 app 模块的 ready 事件触发之后才可应用。

示例：

应用一个与 file:// 性能类似的协定 ：

const electron = require('electron');const app = electron.app;const path = require('path');app.on('ready', function() {    var protocol = electron.protocol;    protocol.registerFileProtocol('atom', function(request, callback) {      var url = request.url.substr(7);      callback({path: path.normalize(__dirname + '/' + url)});    }, function (error) {      if (error)        console.error('注册协定失败')    });});

session模块

session 模块能够用来创立一个新的 Session 对象。

示例：

const BrowserWindow = require('electron').BrowserWindow;var win = new BrowserWindow({ width: 800, height: 600 });win.loadURL("http://github.com");var ses = win.webContents.session;

webContents模块

webContents 是一个 EventEmitter，负责渲染和管制一个网页，是一个 BrowserWindow 对象的属性。

示例：

const BrowserWindow = require('electron').BrowserWindow;var win = new BrowserWindow({width: 800, height: 1500});win.loadURL("https://www.9xkd.com/");var webContents = win.webContents;

webContents 对象可收回下列事件：

链接：https://www.9xkd.com/