Cordova Electron 技术文档

1. 安装指南

1.1 系统要求

• Linux: 需要Python 2.7.x版本。
• macOS: 需要Python 2.7.x版本，并支持TLS 1.2。Xcode 8.2.1或更高版本。
• Windows: 需要Python 2.7.10或更高版本，PowerShell 3.0或更高版本。

1.2 安装步骤

1. 全局安装最新版本的Cordova CLI：

   npm install -g cordova@latest
   

2. 创建一个新的Cordova项目：

   cordova create helloworld
   

3. 进入项目目录：

   cd helloworld
   

4. 添加Electron平台：

   cordova platform add electron
   

5. 运行Electron应用：

   cordova run electron
   

2. 项目的使用说明

2.1 创建项目

使用Cordova CLI创建一个新的项目，并添加Electron平台。

2.2 预览项目

在预览项目时，可以使用--nobuild标志来跳过构建过程，以加快预览速度：

cordova run electron --nobuild

2.3 构建项目

• 调试构建:

  cordova build electron
  

• 发布构建:

  cordova build electron --release
  

3. 项目API使用文档

3.1 自定义应用图标

在config.xml文件中使用<icon>元素来定义应用图标。可以为应用和安装程序分别定义图标，图标应至少为512x512像素。

示例：

<platform name="electron">
  <icon src="res/electron/icon.png" />
</platform>

3.2 自定义应用窗口选项

Electron提供了多种选项来操作BrowserWindow。可以在项目根目录下创建一个Electron设置文件，并在config.xml中设置其相对路径。

示例：

<platform name="electron">
  <preference name="ElectronSettingsFilePath" value="res/electron/settings.json" />
</platform>

在settings.json文件中，可以设置BrowserWindow的选项。

示例：

{
  "browserWindow": {
    "width": 1024,
    "height": 768,
    "resizable": false,
    "fullscreen": true
  }
}

3.3 支持Node.js和Electron API

通过设置nodeIntegration标志为true，可以启用Node.js和Electron API的支持。

示例：

{
  "browserWindow": {
    "webPreferences": {
      "nodeIntegration": true
    }
  }
}

4. 项目安装方式

4.1 使用Cordova CLI

如前所述，使用Cordova CLI是最推荐的方式。通过全局安装Cordova CLI，并使用命令行创建和管理项目。

4.2 独立安装（不推荐）

当前版本的独立安装方式存在问题，不推荐使用。如果需要使用，请参考项目README中的相关部分。