electron-egg

When to use this skill

• Install and set up Electron EGG in a project
• Create Electron desktop applications
• Use Electron EGG core features
• Configure Electron EGG
• Handle main process and renderer process communication
• Use Electron EGG API methods
• Build and package Electron applications
• Troubleshoot Electron EGG issues

How to use this skill

1. Identify the topic from the user's request:
   • Installation/安装 →

     examples/guide/installation.md

   • Quick Start/快速开始 →

     examples/guide/quick-start.md

   • Features/功能特性 →

     examples/features/

   • API/API 文档 →

     api/

2. Load the appropriate example file from the

   examples/

   directory:
   Guide (使用文档):

   • examples/guide/intro.md

     - Introduction to Electron EGG

   • examples/guide/installation.md

     - Installation guide

   • examples/guide/quick-start.md

     - Quick start guide

   • examples/guide/project-structure.md

     - Project structure

   • examples/guide/configuration.md

     - Configuration

   • examples/guide/build.md

     - Build and package
   Features (功能特性):

   • examples/features/main-process.md

     - Main process

   • examples/features/renderer-process.md

     - Renderer process

   • examples/features/ipc-communication.md

     - IPC communication

   • examples/features/window-management.md

     - Window management

   • examples/features/menu.md

     - Menu

   • examples/features/tray.md

     - System tray

   • examples/features/auto-updater.md

     - Auto updater

   • examples/features/plugin-system.md

     - Plugin system
3. Follow the specific instructions in that example file for syntax, structure, and best practices
   Important Notes:
   • Electron EGG is based on Electron and Egg.js
   • Main process and renderer process separation
   • IPC communication between processes
   • Each example file includes key concepts, code examples, and key points
4. Reference API documentation in the

   api/

   directory when needed:

   • api/main-api.md

     - Main process API

   • api/renderer-api.md

     - Renderer process API

   • api/ipc-api.md

     - IPC API

   • api/window-api.md

     - Window API

   • api/config-api.md

     - Configuration API
   API Files:

   • api/main-api.md

     - Application class, BrowserWindow, ipcMain, app methods

   • api/renderer-api.md

     - ipcRenderer, contextBridge, DOM APIs

   • api/ipc-api.md

     - IPC communication methods and events

   • api/window-api.md

     - Window creation and management

   • api/config-api.md

     - Configuration options and environment variables
5. Use templates from the

   templates/

   directory:

   • templates/installation.md

     - Installation templates

   • templates/project-setup.md

     - Project setup templates

   • templates/configuration.md

     - Configuration templates

1. Understanding Electron EGG

• Electron: Cross-platform desktop application framework
• Egg.js: Node.js enterprise application framework
• Main Process: Main application process
• Renderer Process: UI rendering process
• IPC: Inter-process communication
• Plugin System: Extensible plugin architecture

2. Installation

npm install electron-egg

yarn add electron-egg

pnpm add electron-egg

3. Basic Setup

// main.js
const { Application } = require('electron-egg')

const app = new Application({
  // Configuration
})

app.start()

Doc mapping (one-to-one with official documentation)

• examples/

  → https://www.kaka996.com/pages/987b1c/

• api/

  → https://www.kaka996.com/pages/a99b72/

Examples and Templates

examples/

• Identify the topic from the user's request
• Load the appropriate example file from the mapping above
• Follow the instructions, syntax, and best practices in that file
• Adapt the code examples to your specific use case

• Reference templates in

  templates/

  directory for common scaffolding
• Adapt templates to your specific needs and coding style

API Reference

api/

Main Process API (

api/main-api.md

)

• Application class and methods
• BrowserWindow creation and management
• ipcMain IPC handling
• Application lifecycle hooks

Renderer Process API (

api/renderer-api.md

)

• ipcRenderer IPC communication
• contextBridge for secure API exposure
• DOM APIs available in renderer
• Event handling

IPC API (

api/ipc-api.md

)

• IPC communication methods (ipcMain, ipcRenderer)
• Message sending and receiving
• Async and sync IPC
• Event handling and channels

Window API (

api/window-api.md

)

• BrowserWindow creation and options
• Window management methods
• Window events
• Window lifecycle

Configuration API (

api/config-api.md

)

• Configuration file structure
• App info configuration
• Window configuration
• Plugin configuration
• Environment variables

1. Identify the API you need help with
2. Load the corresponding API file from the

   api/

   directory
3. Find the API signature, parameters, return type, and examples
4. Reference the linked example files for detailed usage patterns
5. All API files include links to relevant example files in the

   examples/

   directory

Best Practices

1. Separate processes: Keep main process and renderer process code separate
2. Use IPC: Use IPC for inter-process communication
3. Handle errors: Properly handle errors in both processes
4. Security: Follow Electron security best practices
5. Performance: Optimize application performance
6. Build configuration: Configure build and package properly
7. Plugin system: Use plugin system for extensibility

Resources

• Official Documentation: https://www.kaka996.com/
• Usage Guide: https://www.kaka996.com/pages/987b1c/
• API Documentation: https://www.kaka996.com/pages/a99b72/
• Gitee Repository: https://gitee.com/dromara/electron-egg

Keywords