Официальное руководство

Убедитесь, что Вы используете документацию, соответствующую вашей версии Electron. Версия должна быть частью URL-адреса страницы. If it's not, you are probably using the documentation of a development branch which may contain API changes that are not compatible with your Electron version. Чтобы просмотреть более старые версии документации, Вы можете использовать browse by tag на GitHub, открыв список «Switch branches/tags» и выбрав тег, соответствующий вашей версии.

FAQ

Есть вопросы, которые довольно часто задаваются. Проверьте это перед созданием проблемы:

• FAQ по Electron

Руководство

Начало работы

• Введение
• Руководство для начинающих
• Моделирование процесса

Изучите основы

• Добавление функционала в Ваше приложение
  • Notification (Оповещения)
  • Недавние документы
  • Прогресс приложения
  • Пользовательское меню macOS
  • Пользовательские задачи Windows
  • Пользовательские действия на Linux
  • Горячие клавиши
  • Оффлайн/Онлайн обнаружение
  • Представленный файл для macOS BrowserWindows
  • Нативное перемещение файла
  • Navigation History
  • Закадровый рендеринг
  • Темный режим
  • Встраивание веб в Electron
• Макеты и CLI
  • Макеты против CLI
  • Electron Forge
  • electron-builder
  • electron-react-boilerplate
  • Другие инструменты и макеты

Advanced topics

• Архитектура приложения
  • Использование нативных модулей Node.js
  • Performance Strategies
  • Стратегии безопасности
  • Песочница процессов
• Доступность
  • Включение функций специальных возможностей вручную
• Тестирование и отладка
  • Отладка главного процесса
  • Отладка с кодом Visual Studio
  • Тестирование с помощью систем непрерывной интеграции (Travis, Jenkins)
  • Расширение DevTools
  • Автоматизированное тестирование
  • REPL
• Распространение
  • Подписывание кода
  • Mac App Store
  • Windows Store
  • Snapcraft
  • ASAR Archives
• Обновления
• Получение поддержки

Подробное руководство

Эти индивидуальные руководства расширят темы, обсуждаемые выше.

• Установка Electron
  • Прокси
  • Пользовательские зеркала и кеши
  • Устранение проблем
• Отзыв разработчика Electron Releases &
  • Политика контроля версиями
  • Графики выпуска

---

• Глоссарий

Справочник по API

• Объект процесса
• Поддерживаемые параметры командной строки
• Переменные окружения
• Chrome Extensions Support
• Критические изменения в API

Пользовательские DOM-элементы:

• Тег <webview>
• Функция window.open

Модули для главного процесса:

• app
• autoUpdater
• BaseWindow
• BrowserWindow
• contentTracing
• desktopCapturer
• dialog
• globalShortcut
• inAppPurchase
• ipcMain
• Menu
• MenuItem
• MessageChannelMain
• MessagePortMain
• nativeTheme (Родная тема)
• net
• netLog
• Notification (Оповещения)
• powerMonitor
• powerSaveBlocker
• protocol
• pushNotifications
• safeStorage
• screen
• session
• ShareMenu
• systemPreferences
• TouchBar
• Tray
• utilityProcess
• View
• webContents
• webFrameMain
• WebContentsView

Модули для процесса-рендерера (веб-страницы):

• contextBridge
• ipcRenderer
• webFrame

Модули для обоих процессов:

• clipboard (non-sandboxed renderers only)
• crashReporter
• nativeImage
• shell (non-sandboxed renderers only)

Разработка

See development/README.md