Electron API 列表

Electron API

• 控制应用事件生命周期
• 运行于主进程

app事件

• 启动与初始化事件
  • will-finish-launching：Windows和Linux与ready相同，macOS类似NSApplication的对应提示
  • ready：Electron初始化完成时触发，可通过isReady或whenReady判断
• 窗口管理事件
  • window-all-closed：所有窗口关闭时触发，可控制程序是否退出
  • browser-window-blur：窗口失去焦点时触发
  • browser-window-focus：窗口获得焦点时触发
  • browser-window-created：新窗口创建时触发
• 系统交互事件
  • open-file：用户在应用中打开文件时触发，macOS和Windows处理方式不同
  • open-url：用户在应用中打开URL时触发，需在Info.plist定义url scheme
  • activate：应用被激活时触发，用于处理激活相关逻辑
• 进程相关事件
  • render-process-gone：渲染器进程意外消失时触发
  • child-process-gone：子进程意外消失时触发，不包括渲染器进程

app方法

• 进程控制方法
  • quit：关闭所有窗口，触发before-quit和will-quit事件
  • exit：立即退出，不触发相关事件
  • relaunch：当前实例退出时重新启动应用，需搭配quit或exit使用
• 路径操作方法
  • getPath：获取不同类型的路径，如home、appData等
  • setPath：重写特定路径，操作前需确保目录存在
• 系统集成方法
  • setAsDefaultProtocolClient：设置应用为协议默认处理程序
  • setJumpList：设置或删除应用的自定义跳转列表
  • setLoginItemSettings：设置应用的登录项设置

app属性

• 辅助功能属性
  • accessibilitySupportEnabled：判断或设置Chrome辅助功能状态
• 菜单属性
  • applicationMenu：获取或设置应用菜单
• 打包属性
  • isPackaged：判断应用是否已打包，区分开发和生产环境