2015-11-21 01:31:52 +00:00
|
|
|
Please make sure that you use the documents that match your Electron version.
|
2015-11-21 02:22:16 +00:00
|
|
|
The version number should be a part of the page URL. If it's not, you are
|
|
|
|
|
probably using the documentation of a development branch which may contain API
|
2016-09-20 04:09:02 +00:00
|
|
|
changes that are not compatible with your Electron version. To view older
|
|
|
|
|
versions of the documentation, you can
|
|
|
|
|
[browse by tag](https://github.com/electron/electron/tree/v1.4.0)
|
|
|
|
|
on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag
|
|
|
|
|
that matches your version.
|
2015-11-21 01:31:52 +00:00
|
|
|
|
2016-01-05 11:52:57 +00:00
|
|
|
## FAQ
|
|
|
|
|
|
2016-09-20 04:09:31 +00:00
|
|
|
There are questions that are asked quite often. Check this out before creating
|
2016-01-05 11:52:57 +00:00
|
|
|
an issue:
|
|
|
|
|
|
2016-07-09 13:14:42 +00:00
|
|
|
* [Electron FAQ](faq.md)
|
2016-01-05 11:52:57 +00:00
|
|
|
|
2018-02-20 00:09:58 +00:00
|
|
|
## Guides and Tutorials
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2018-02-20 00:09:58 +00:00
|
|
|
* [Setting up the Development Environment](tutorial/development-environment.md)
|
|
|
|
|
* [Setting up macOS](tutorial/development-environment.md#setting-up-macos)
|
|
|
|
|
* [Setting up Windows](tutorial/development-environment.md#setting-up-windows)
|
|
|
|
|
* [Setting up Linux](tutorial/development-environment.md#setting-up-linux)
|
|
|
|
|
* [Choosing an Editor](tutorial/development-environment.md#a-good-editor)
|
|
|
|
|
* [Creating your First App](tutorial/first-app.md)
|
|
|
|
|
* [Installing Electron](tutorial/first-app.md#installing-electron)
|
|
|
|
|
* [Electron Development in a Nutshell](tutorial/first-app.md#electron-development-in-a-nutshell)
|
|
|
|
|
* [Running Your App](tutorial/first-app.md#running-your-app)
|
|
|
|
|
* [Boilerplates and CLIs](tutorial/boilerplates-and-clis.md)
|
|
|
|
|
* [Boilerplate vs CLI](tutorial/boilerplates-and-clis.md#boilerplate-vs-cli)
|
|
|
|
|
* [electron-forge](tutorial/boilerplates-and-clis.md#electron-forge)
|
|
|
|
|
* [electron-builder](tutorial/boilerplates-and-clis.md#electron-builder)
|
|
|
|
|
* [electron-react-boilerplate](tutorial/boilerplates-and-clis.md#electron-react-boilerplate)
|
2018-02-20 00:38:59 +00:00
|
|
|
* [Other Tools and Boilerplates](tutorial/boilerplates-and-clis.md#other-tools-and-boilerplates)
|
2018-02-20 00:09:58 +00:00
|
|
|
* [Application Architecture](tutorial/application-architecture.md)
|
|
|
|
|
* [Main and Renderer Processes](tutorial/application-architecture.md#main-and-renderer-processes)
|
|
|
|
|
* [Using Electron's APIs](tutorial/application-architecture.md#using-electron-apis)
|
|
|
|
|
* [Using Node.js APIs](tutorial/application-architecture.md#using-node.js-apis)
|
|
|
|
|
* [Using Native Node.js Modules](tutorial/using-native-node-modules.md)
|
|
|
|
|
* [Inter-Process Communication](tutorial/application-architecture.md#)
|
2018-02-20 15:47:18 +00:00
|
|
|
* Adding Features to Your App
|
2018-02-20 00:09:58 +00:00
|
|
|
* [Notifications](tutorial/notifications.md)
|
|
|
|
|
* [Recent Documents](tutorial/desktop-environment-integration.md#recent-documents-windows-mac-os)
|
2018-02-20 00:25:02 +00:00
|
|
|
* [Application Progress](tutorial/progress-bar.md)
|
2018-02-20 00:09:58 +00:00
|
|
|
* [Custom Dock Menu](tutorial/desktop-environment-integration.md#custom-dock-menu-mac-os)
|
|
|
|
|
* [Custom Windows Taskbar](tutorial/windows-taskbar.md)
|
2018-02-20 15:47:18 +00:00
|
|
|
* [Custom Linux Desktop Actions](tutorial/linux-desktop-actions.md)
|
2018-02-20 00:09:58 +00:00
|
|
|
* [Keyboard Shortcuts](tutorial/keyboard-shortcuts.md)
|
|
|
|
|
* [Offline/Online Detection](tutorial/online-offline-events.md)
|
2018-02-20 15:47:18 +00:00
|
|
|
* [Represented File for macOS BrowserWindows](tutorial/represented-file.md)
|
2018-02-20 00:25:02 +00:00
|
|
|
* [Native File Drag & Drop](tutorial/native-file-drag-drop.md)
|
2018-02-20 00:09:58 +00:00
|
|
|
* [Application Accessibility](tutorial/accessibility.md)
|
|
|
|
|
* [Spectron](tutorial/accessibility.md#spectron)
|
|
|
|
|
* [Devtron](tutorial/accessibility.md#devtron)
|
|
|
|
|
* [Enabling Accessibility](tutorial/accessibility.md#enabling-accessibility)
|
2018-02-21 18:12:19 +00:00
|
|
|
* [Application Testing and Debugging](tutorial/application-debugging.md)
|
|
|
|
|
* [Debugging the Main Process](tutorial/debugging-main-process.md)
|
|
|
|
|
* [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
|
|
|
|
|
* [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
|
|
|
|
|
* [DevTools Extension](tutorial/devtools-extension.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Application Distribution](tutorial/application-distribution.md)
|
2018-02-21 18:12:19 +00:00
|
|
|
* [Supported Platforms](tutorial/supported-platforms.md)
|
2018-02-20 00:09:58 +00:00
|
|
|
* [Mac App Store](tutorial/mac-app-store-submission-guide.md)
|
|
|
|
|
* [Windows Store](tutorial/windows-store-guide.md)
|
|
|
|
|
* [Snapcraft](tutorial/snapcraft.md)
|
|
|
|
|
* [Application Security](tutorial/security.md)
|
|
|
|
|
* [Reporting Security Issues](tutorial/security.md#reporting-security-issues)
|
|
|
|
|
* [Chromium Security Issues and Upgrades](tutorial/security.md#chromium-security-issues-and-upgrades)
|
|
|
|
|
* [Electron Security Warnings](tutorial/security.md#electron-security-warnings)
|
|
|
|
|
* [Security Checklist](tutorial/security.md#checklist-security-recommendations)
|
|
|
|
|
* [Application Updates](tutorial/updates.md)
|
|
|
|
|
* [Deploying an Update Server](tutorial/updates.md#deploying-an-update-server)
|
|
|
|
|
* [Implementing Updates in Your App](tutorial/updates.md#implementing-updates-in-your-app)
|
|
|
|
|
* [Applying Updates](tutorial/updates.md#applying-updates)
|
|
|
|
|
|
|
|
|
|
## Detailed Tutorials
|
|
|
|
|
|
2018-02-21 18:12:19 +00:00
|
|
|
These individual tutorials expand on topics discussed in the guide above.
|
2018-02-20 00:09:58 +00:00
|
|
|
|
|
|
|
|
* [In Detail: Installing Electron](tutorial/installation.md)
|
|
|
|
|
* [Global versus Local Installation](tutorial/installation.md#global-versus-local-installation)
|
|
|
|
|
* [Proxies](tutorial/installation.md#proxies)
|
|
|
|
|
* [Custom Mirrors and Caches](tutorial/installation.md#custom-mirrors-and-caches)
|
|
|
|
|
* [Troubleshooting](tutorial/installation.md#troubleshooting)
|
|
|
|
|
* [In Detail: Electron's Versioning Scheme](tutorial/electron-versioning.md)
|
|
|
|
|
* [semver](tutorial/electron-versioning.md#semver)
|
|
|
|
|
* [Stabilization Branches](tutorial/electron-versioning.md#stabilization-branches)
|
|
|
|
|
* [Beta Releases and Bug Fixes](tutorial/electron-versioning.md#beta-releases-and-bug-fixes)
|
|
|
|
|
* [In Detail: Packaging App Source Code with asar](tutorial/application-packaging.md)
|
|
|
|
|
* [Generating asar Archives](tutorial/application-packaging.md#generating-asar-archives)
|
|
|
|
|
* [Using asar Archives](tutorial/application-packaging.md#using-asar-archives)
|
|
|
|
|
* [Limitations](tutorial/application-packaging.md#limitations-of-the-node-api)
|
|
|
|
|
* [Adding Unpacked Files to asar Archives](tutorial/application-packaging.md#adding-unpacked-files-to-asar-archives)
|
|
|
|
|
* [In Detail: Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md)
|
|
|
|
|
* [In Detail: Using Widevine CDM Plugin](tutorial/using-widevine-cdm-plugin.md)
|
2016-08-03 06:38:24 +00:00
|
|
|
* [Offscreen Rendering](tutorial/offscreen-rendering.md)
|
2015-03-17 10:37:18 +00:00
|
|
|
|
2018-02-20 15:47:18 +00:00
|
|
|
---
|
2015-03-17 10:37:18 +00:00
|
|
|
|
2018-02-20 00:09:58 +00:00
|
|
|
* [Glossary of Terms](glossary.md)
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-09-04 20:50:26 +00:00
|
|
|
## API References
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2014-05-05 06:49:05 +00:00
|
|
|
* [Synopsis](api/synopsis.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Process Object](api/process.md)
|
|
|
|
|
* [Supported Chrome Command Line Switches](api/chrome-command-line-switches.md)
|
2015-11-26 12:37:48 +00:00
|
|
|
* [Environment Variables](api/environment-variables.md)
|
2014-05-05 06:49:05 +00:00
|
|
|
|
2015-09-04 21:31:33 +00:00
|
|
|
### Custom DOM Elements:
|
2014-10-25 06:58:32 +00:00
|
|
|
|
2015-09-04 20:50:26 +00:00
|
|
|
* [`File` Object](api/file-object.md)
|
2016-11-09 23:04:00 +00:00
|
|
|
* [`<webview>` Tag](api/webview-tag.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [`window.open` Function](api/window-open.md)
|
2014-10-25 06:58:32 +00:00
|
|
|
|
2015-09-04 21:31:33 +00:00
|
|
|
### Modules for the Main Process:
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2014-05-05 06:24:57 +00:00
|
|
|
* [app](api/app.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [autoUpdater](api/auto-updater.md)
|
2017-05-22 14:12:17 +00:00
|
|
|
* [BrowserView](api/browser-view.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [BrowserWindow](api/browser-window.md)
|
|
|
|
|
* [contentTracing](api/content-tracing.md)
|
2014-05-05 06:24:57 +00:00
|
|
|
* [dialog](api/dialog.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [globalShortcut](api/global-shortcut.md)
|
2018-01-10 08:21:52 +00:00
|
|
|
* [inAppPurchase](api/in-app-purchase.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [ipcMain](api/ipc-main.md)
|
|
|
|
|
* [Menu](api/menu.md)
|
|
|
|
|
* [MenuItem](api/menu-item.md)
|
2016-11-01 15:50:55 +00:00
|
|
|
* [net](api/net.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [powerMonitor](api/power-monitor.md)
|
|
|
|
|
* [powerSaveBlocker](api/power-save-blocker.md)
|
2014-05-05 06:24:57 +00:00
|
|
|
* [protocol](api/protocol.md)
|
2015-08-20 13:25:22 +00:00
|
|
|
* [session](api/session.md)
|
2016-04-25 06:36:38 +00:00
|
|
|
* [systemPreferences](api/system-preferences.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [Tray](api/tray.md)
|
2016-07-08 00:33:22 +00:00
|
|
|
* [webContents](api/web-contents.md)
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-09-04 21:31:33 +00:00
|
|
|
### Modules for the Renderer Process (Web Page):
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-12-08 04:43:44 +00:00
|
|
|
* [desktopCapturer](api/desktop-capturer.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [ipcRenderer](api/ipc-renderer.md)
|
2014-05-05 06:24:57 +00:00
|
|
|
* [remote](api/remote.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [webFrame](api/web-frame.md)
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-09-04 21:31:33 +00:00
|
|
|
### Modules for Both Processes:
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2014-05-05 06:24:57 +00:00
|
|
|
* [clipboard](api/clipboard.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [crashReporter](api/crash-reporter.md)
|
|
|
|
|
* [nativeImage](api/native-image.md)
|
2014-05-05 06:24:57 +00:00
|
|
|
* [screen](api/screen.md)
|
|
|
|
|
* [shell](api/shell.md)
|
2014-05-05 06:49:05 +00:00
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Coding Style](development/coding-style.md)
|
2016-10-07 21:03:03 +00:00
|
|
|
* [Using clang-format on C++ Code](development/clang-format.md)
|
2017-12-28 11:18:33 +00:00
|
|
|
* [Testing](development/testing.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Source Code Directory Structure](development/source-code-directory-structure.md)
|
|
|
|
|
* [Technical Differences to NW.js (formerly node-webkit)](development/atom-shell-vs-node-webkit.md)
|
|
|
|
|
* [Build System Overview](development/build-system-overview.md)
|
2016-06-18 13:26:26 +00:00
|
|
|
* [Build Instructions (macOS)](development/build-instructions-osx.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Build Instructions (Windows)](development/build-instructions-windows.md)
|
|
|
|
|
* [Build Instructions (Linux)](development/build-instructions-linux.md)
|
2016-10-28 21:32:48 +00:00
|
|
|
* [Debug Instructions (macOS)](development/debugging-instructions-macos.md)
|
2016-08-02 02:15:03 +00:00
|
|
|
* [Debug Instructions (Windows)](development/debug-instructions-windows.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Setting Up Symbol Server in debugger](development/setting-up-symbol-server.md)
|
2016-10-24 01:21:02 +00:00
|
|
|
* [Documentation Styleguide](styleguide.md)
|
2018-02-12 14:16:29 +00:00
|
|
|
* [Contributing to Electron](../CONTRIBUTING.md)
|
|
|
|
|
* [Issues](development/issues.md)
|
|
|
|
|
* [Pull Requests](development/pull-requests.md)
|
2018-01-12 15:24:48 +00:00
|
|
|
* [Upgrading Chromium](development/upgrading-chromium.md)
|
2017-03-23 05:59:11 +00:00
|
|
|
* [Chromium Development](development/chromium-development.md)
|
2017-03-24 22:40:23 +00:00
|
|
|
* [V8 Development](development/v8-development.md)
|
