SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillselectron

electron

Coding & development

View repository

Updated 10-15 21:48

About this skill

When to use this skill

Use this skill whenever the user wants to:

  • Build cross-platform desktop applications with Electron
  • Understand Electron architecture (main process, renderer process, preload)
  • Implement IPC (Inter-Process Communication) between processes
  • Create and manage BrowserWindow instances
  • Implement menus, tray icons, and native features
  • Package and distribute Electron applications
  • Use Electron Forge for project scaffolding and building
  • Debug and test Electron applications
  • Implement security best practices
  • Use Electron APIs (app, BrowserWindow, ipcMain, ipcRenderer, etc.)

How to use this skill

This skill is organized to match the Electron official documentation structure (https://www.electronjs.org/zh/docs/latest/, https://www.electronjs.org/zh/docs/latest/api/app). When working with Electron:

  1. Identify the topic from the user's request:

    • Getting started/Quick start → examples/getting-started/installation.md or examples/getting-started/quick-start.md
    • Main process/Main process → examples/processes/main-process.md
    • Renderer process/Renderer process → examples/processes/renderer-process.md
    • IPC communication/IPC communication → examples/processes/ipc-communication.md
    • BrowserWindow/Window → examples/api/browser-window.md
    • Menu/Menu → examples/api/menu.md
    • Packaging/Packaging → examples/advanced/packaging.md
    • Security/Security → examples/advanced/security.md

  2. Load the appropriate example file from the examples/ directory:

    Getting Started (Quick start) - examples/getting-started/:

    • examples/getting-started/installation.md - Installing Electron and basic setup
    • examples/getting-started/quick-start.md - Quick start tutorial

    Processes (Processes) - examples/processes/:

    • examples/processes/main-process.md - Main process concepts and usage
    • examples/processes/renderer-process.md - Renderer process concepts
    • examples/processes/preload-scripts.md - Preload scripts usage
    • examples/processes/ipc-communication.md - IPC communication patterns

    API Examples (API examples) - examples/api/:

    • examples/api/browser-window.md - BrowserWindow usage
    • examples/api/menu.md - Menu and context menu
    • examples/api/tray.md - System tray
    • examples/api/dialog.md - File dialogs
    • examples/api/ipc-main.md - ipcMain usage
    • examples/api/ipc-renderer.md - ipcRenderer usage

    Advanced (Advanced) - examples/advanced/:

    • examples/advanced/packaging.md - Application packaging
    • examples/advanced/security.md - Security best practices
    • examples/advanced/auto-updater.md - Auto updater
    • examples/advanced/native-modules.md - Native modules

    Tools (Tools) - examples/tools/:

    • examples/tools/electron-forge.md - Electron Forge usage
    • examples/tools/electron-fiddle.md - Electron Fiddle usage

  3. Follow the specific instructions in that example file for syntax, structure, and best practices

    Important Notes:

    • All examples follow Electron latest API
    • Examples use both CommonJS (require) and ES modules (import)
    • Each example file includes key concepts, code examples, and key points
    • Always check the example file for best practices and common patterns
    • Electron supports Windows, macOS, and Linux

  4. Reference API documentation in the api/ directory when needed:

    • api/app.md - app module 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. Use templates from the templates/ directory:

    • templates/main-process.md - Main process template
    • templates/preload-script.md - Preload script template
    • templates/renderer-process.md - Renderer process template
    • templates/package-json.md - package.json template

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

Examples and Templates

This skill includes detailed examples organized to match the official documentation structure. All examples are in the examples/ directory (see mapping above).

To use 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

To use templates:

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

API Reference

Detailed API documentation is available in the api/ directory, organized to match the official Electron API documentation structure:

Core APIs (api/)

  • api/app.md - app module 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

To use API reference:

  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. Security: Never enable nodeIntegration in renderer process, use preload scripts
  2. Process separation: Keep main and renderer processes separate
  3. IPC communication: Use IPC for safe communication between processes
  4. Resource management: Properly clean up resources (windows, listeners)
  5. Error handling: Implement proper error handling and crash reporting
  6. Performance: Optimize for performance, use webContents for debugging
  7. Packaging: Use Electron Forge or electron-builder for packaging
  8. Auto updates: Implement auto-updater for production apps
  9. Native modules: Handle native module compatibility
  10. Cross-platform: Test on all target platforms

Resources

Keywords

Electron, desktop app, main process, renderer process, preload, IPC, BrowserWindow, Menu, Tray, Dialog, packaging, electron-builder, electron-forge, electron-fiddle, cross-platform, desktop application, main process, renderer process, IPC communication, window, menu, tray, packaging