Electron-PDF 项目教程

1. 项目的目录结构及介绍

Electron-PDF 项目的目录结构如下：

electron-pdf/
├── app/
│   ├── index.js
│   ├── package.json
│   └── renderer.js
├── bin/
│   └── electron-pdf
├── lib/
│   ├── config.js
│   ├── converter.js
│   └── utils.js
├── test/
│   └── test.js
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

目录介绍

• app/: 包含应用程序的主要文件，如 index.js 和 renderer.js。
• bin/: 包含可执行文件 electron-pdf。
• lib/: 包含项目的核心逻辑文件，如配置文件 config.js 和转换器 converter.js。
• test/: 包含测试文件 test.js。
• .gitignore: Git 忽略文件。
• LICENSE: 项目许可证。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件是 app/index.js。这个文件负责初始化 Electron 应用程序并加载主窗口。

const { app, BrowserWindow } = require('electron');
const path = require('path');

function createWindow() {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'renderer.js')
    }
  });

  mainWindow.loadFile('index.html');
}

app.whenReady().then(() => {
  createWindow();

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow();
  });
});

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit();
});

启动文件功能

• 创建主窗口并设置窗口大小和预加载脚本。
• 加载 index.html 文件。
• 处理应用程序的生命周期事件，如激活和关闭窗口。

3. 项目的配置文件介绍

项目的配置文件是 lib/config.js。这个文件负责管理应用程序的配置选项。

module.exports = {
  pdfOptions: {
    format: 'A4',
    printBackground: true
  },
  outputDirectory: './output',
  defaultUrl: 'http://example.com'
};

配置文件功能

• pdfOptions: 设置 PDF 生成的选项，如页面格式和是否打印背景。
• outputDirectory: 设置输出 PDF 文件的目录。
• defaultUrl: 设置默认加载的 URL。

以上是 Electron-PDF 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。