mcpField
E
electron

electron

github.com/full-stack-skills开发7384 次安装4 周前更新
代码仓库

关于 electron

electron 是面向 Electron 桌面应用开发和维护者的技能。它按主题组织示例、API 参考和模板,涵盖进程通信、打包与安全等内容。

主要功能

  1. 01按主题整理的 Electron 示例和 API 参考
  2. 02主进程、渲染进程及预加载脚本模板
  3. 03IPC 与 BrowserWindow 指南
  4. 04菜单、托盘和对话框示例
  5. 05打包、安全与调试指导

适用场景

  1. 01规划 Electron 应用的进程结构
  2. 02实现主进程与渲染进程间的 IPC
  3. 03构建窗口、菜单或托盘功能
  4. 04准备打包或安全相关改动

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/full-stack-skills/electron-skills --skill electron

安装后在 Claude Code 中输入/electron确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

LICENSE.txt
agents/
openai.yaml
api/
app.md
browser-window.md
examples/advanced/
packaging.md
examples/api/
browser-window.md
menu.md
examples/getting-started/
installation.md
quick-start.md
examples/processes/
ipc-communication.md
main-process.md
templates/
main-process.md
preload-script.md

详细介绍

何时使用此技能

当用户想要进行以下操作时,请使用此技能:

  • 使用 Electron 构建跨平台桌面应用程序
  • 了解 Electron 架构(主进程、渲染进程、预加载)
  • 实现进程间 IPC(进程间通信)
  • 创建和管理 BrowserWindow 实例
  • 实现菜单、托盘图标和原生功能
  • 打包和分发 Electron 应用程序
  • 使用 Electron Forge 搭建项目和进行构建
  • 调试和测试 Electron 应用程序
  • 实现安全最佳实践
  • 使用 Electron API(app、BrowserWindow、ipcMain、ipcRenderer 等)

如何使用此技能

此技能的组织结构与 Electron 官方文档结构一致(https://www.electronjs.org/zh/docs/latest/、https://www.electronjs.org/zh/docs/latest/api/app)。使用 Electron 时:

  1. 根据用户的请求确定主题:

    • 入门/快速开始 → examples/getting-started/installation.md 或 examples/getting-started/quick-start.md
    • 主进程 → examples/processes/main-process.md
    • 渲染进程 → examples/processes/renderer-process.md
    • IPC 通信 → examples/processes/ipc-communication.md
    • BrowserWindow/窗口 → examples/api/browser-window.md
    • 菜单 → examples/api/menu.md
    • 打包 → examples/advanced/packaging.md
    • 安全 → examples/advanced/security.md
  2. 从 examples/ 目录加载合适的示例文件:

    入门(快速开始)- examples/getting-started/:

    • examples/getting-started/installation.md - 安装 Electron 和基础设置
    • examples/getting-started/quick-start.md - 快速入门教程

    进程 - examples/processes/:

    • examples/processes/main-process.md - 主进程概念和用法
    • examples/processes/renderer-process.md - 渲染进程概念
    • examples/processes/preload-scripts.md - 预加载脚本用法
    • examples/processes/ipc-communication.md - IPC 通信模式

    API 示例 - examples/api/:

    • examples/api/browser-window.md - BrowserWindow 用法
    • examples/api/menu.md - 菜单和上下文菜单
    • examples/api/tray.md - 系统托盘
    • examples/api/dialog.md - 文件对话框
    • examples/api/ipc-main.md - ipcMain 用法
    • examples/api/ipc-renderer.md - ipcRenderer 用法

    高级 - examples/advanced/:

    • examples/advanced/packaging.md - 应用程序打包
    • examples/advanced/security.md - 安全最佳实践
    • examples/advanced/auto-updater.md - 自动更新程序
    • examples/advanced/native-modules.md - 原生模块

    工具 - examples/tools/:

    • examples/tools/electron-forge.md - Electron Forge 用法
    • examples/tools/electron-fiddle.md - Electron Fiddle 用法
  3. 按照对应示例文件中的具体说明编写语法、结构并遵循最佳实践

    重要说明:

    • 所有示例均遵循 Electron 最新 API
    • 示例同时使用 CommonJS(require)和 ES 模块(import)
    • 每个示例文件都包含关键概念、代码示例和要点
    • 务必查看示例文件,了解最佳实践和常见模式
    • Electron 支持 Windows、macOS 和 Linux
  4. 根据需要参考 api/ 目录中的 API 文档:

    • api/app.md - app 模块 API
    • api/browser-window.md - BrowserWindow API
    • api/ipc-main.md - ipcMain API
    • api/ipc-renderer.md - ipcRenderer API
    • api/menu.md - Menu API
    • api/tray.md - Tray API
  5. 使用 templates/ 目录中的模板:

    • templates/main-process.md - 主进程模板
    • templates/preload-script.md - 预加载脚本模板
    • templates/renderer-process.md - 渲染进程模板
    • templates/package-json.md - package.json 模板
文档映射(一一对应官方文档)

示例和模板

此技能包含详细示例,其组织结构与官方文档一致。所有示例均位于 examples/ 目录中(参见上方映射)。

使用示例:

  • 根据用户请求确定主题
  • 从映射对应的位置加载合适的示例文件
  • 遵循该文件中的说明、语法和最佳实践
  • 根据具体用例调整代码示例

使用模板:

  • 在 templates/ 目录中查找常见脚手架模板
  • 根据具体需求和编码风格调整模板

API 参考

详细的 API 文档位于 api/ 目录中,其组织结构与官方 Electron API 文档一致:

核心 API(api/)
  • api/app.md - app 模块 API
  • api/browser-window.md - BrowserWindow API
  • api/ipc-main.md - ipcMain API
  • api/ipc-renderer.md - ipcRenderer API
  • api/menu.md - Menu API
  • api/tray.md - Tray API
  • api/dialog.md - Dialog API

使用 API 参考:

  1. 确定需要帮助的 API
  2. 从 api/ 目录加载对应的 API 文件
  3. 查找 API 签名、参数、返回类型和示例
  4. 参考链接的示例文件,了解详细用法
  5. 所有 API 文件都包含指向 examples/ 目录中相关示例文件的链接

最佳实践

  1. 安全性:切勿在渲染进程中启用 nodeIntegration,应使用预加载脚本
  2. 进程隔离:保持主进程与渲染进程相互隔离
  3. IPC 通信:使用 IPC 在进程之间安全地通信
  4. 资源管理:妥善清理资源(窗口、监听器)
  5. 错误处理:实施完善的错误处理和崩溃报告
  6. 性能:优化性能,并使用 webContents 进行调试
  7. 打包:使用 Electron Forge 或 electron-builder 进行打包
  8. 自动更新:为生产应用实现自动更新程序
  9. 原生模块:处理原生模块兼容性
  10. 跨平台:在所有目标平台上进行测试

资源

关键词

Electron、桌面应用、主进程、渲染进程、preload、IPC、BrowserWindow、Menu、Tray、Dialog、打包、electron-builder、electron-forge、electron-fiddle、跨平台、桌面应用、主进程、渲染进程、IPC 通信、窗口、菜单、托盘、打包

评论

支持 Markdown