website

Electron Docs

所属分类:开发者在线工具箱

Electron 官方文档:用 JavaScript 开发桌面应用的教程与 API

Electron 是用 JavaScript、HTML 和 CSS 开发桌面应用的框架,官方文档站覆盖入门介绍、分步教程、进程说明、最佳实践与 API 参考。文档默认显示最新版本,并提供德语、西班牙语、法语、日语、葡萄牙语、俄语和中文等语言入口。

Electron Docs:从入门教程到 API 参考,学习用 JavaScript 开发桌面应用

发布于 2026年10月18日更新于 2026年10月29日

入门页与 Fiddle 示例

介绍页说明,Electron 把 Chromium 和 Node.js 嵌入到应用的二进制文件中,因此一套 JavaScript 代码可以开发出在 Windows、macOS 和 Linux 上运行的应用。页面建议先读教程,再浏览示例和 API 文档。

页面还介绍了 Electron Fiddle:这是由 Electron 维护者支持的沙盒应用,适合用来试验 API 或在开发中验证想法。文档中的教程示例旁有 Open in Fiddle 按钮,安装 Fiddle 后点击即可把示例载入 Fiddle 中运行。

Electron 介绍页截图:左侧为 Get Started 目录,正文为 What is Electron? 与 Getting started 小节,示例代码块上方显示 Open in Fiddle 按钮

截图中 Fiddle 示例的版本号为 44.9.0,截至 2026 年 10 月,官网同一位置显示为 45.1.0。

教程的范围与前提

教程分为六个部分:Prerequisites、Building your First App、Using Preload Scripts、Adding Features、Packaging Your Application 和 Publishing and Updating。教程目标是先从零搭出一个最小应用,再用 Electron Forge 将其打包并分发给用户。

前提页还说明,本教程假设读者已基本熟悉 Node.js 与前端开发。如果想直接获得一个模板项目,页面推荐使用 Electron Forge 的 create-electron-app 命令。

API 参考:app 模块

API 参考的侧边栏按 Main Process Modules、Renderer Process Modules 和 Utility Process Modules 等分组。截图中的 app 页面说明,该模块用于控制应用的事件生命周期,运行在 Main 进程中,并用一段示例演示关闭最后一个窗口时退出应用。页面下方的 Events 部分按顺序列出 will-finish-launching、ready 等事件;侧边栏中的 BrowserView 标注为 Deprecated。

Electron app 模块文档截图:左侧为 Main Process Modules 列表,正文说明 app 控制应用的事件生命周期,右侧列出 Events 小节

其他入口

文档站顶部的 Tools 下拉菜单链接到 Electron Forge 与 Electron Fiddle,Releases 链接到独立的发布说明站点。页面还建议,遇到疑似 Electron 本身的 bug 时,先在 GitHub 的 issue 列表中搜索,没有相同问题再提交报告。