Electron api docs how to#
Electron api docs install#
Electron api docs update#
Electron api docs windows#

Retrieve information about screen size, displays, cursor position, etc. However, in order to enable the Chromium OS sandbox, electron must be run with the -enable-sandbox command line argument. With this option enabled, the renderer must communicate via IPC to the main process in order to access node APIs. Use main process modules from the renderer process.Ĭreate a browser window with a renderer that can run inside Chromium OS sandbox. Register a custom protocol and intercept existing protocol requests. Issue HTTP/HTTPS requests using Chromium's native networking libraryīlock the system from entering low-power (sleep) mode. Locale values returned by app.getLocale().Ĭreate native application menus and context menus.Īdd items to native application menus and context menus.Ĭreate tray, dock, and application icons using PNG or JPG files. Open a window without toolbars, borders, or other graphical 'chrome'.ĭetect keyboard events when the application does not have keyboard focus.Ĭommunicate asynchronously from the main process to renderer processes.Ĭommunicate asynchronously from a renderer process to the main process. Use the HTML5 File API to work natively with files on the filesystem.

Perform copy and paste operations on the system clipboard.Ĭollect tracing data from Chromium's content module for finding performance bottlenecks and slow operations.Īn alternate transport for Chrome's remote debugging protocol.Īccess information about media sources that can be used to capture audio and video from the desktop using the API.ĭisplay native system dialogs for opening and saving files, alerting, etc.Ĭontrol file downloads from remote sources.Ĭontrol application configuration and behavior without changing code.

Electron api docs update#

When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.Control your application's event lifecycle.Įnable apps to automatically update themselves.Ĭommand line switches supported by Electron. Info on reporting bugs, getting help, finding third-party tools and sample apps,Īnd more can be found on the Community page.

Electron api docs how to#

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, We crowdsource translations for our documentation via Crowdin.

See the Advanced Installation Instructions to learn how to use a custom mirror. spawn Electron const child = proc.spawn(electron) will print something similar to /Users/maf/./Electron console.log(electron) Use this to spawn Electron from Node scripts: const electron = require( 'electron') Your Node app (not your Electron app) it will return the file path to theīinary. Most people use Electron from the command line, but if you require electron inside

/community#boilerplates - Sample starter apps created by the community.

electron/electron-quick-start - A very basic starter Electron app.

electron/fiddle - A tool to build, run, and package small Electron experiments.

/docs - All of Electron's documentation.

Repository to see a minimal Electron app in action: git clone It's designed to make the start of your journey with To try out different versions of Electron. To build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and

Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04.

Electron api docs windows#

Windows on ARM support was added in Electron 5.0.8.

Windows (Windows 7 and up): Electron provides ia32 ( x86), 圆4 ( amd64), and arm64 binaries for Windows.

Apple Silicon support was added in Electron 11. macOS (El Capitan and up): Electron provides 64-bit Intel and ARM binaries for macOS.For info on how to manage Electron versions in your apps, seeĮach Electron release provides binaries for macOS, Windows, and Linux.

Electron api docs install#

The preferred method is to install Electron as a development dependency in yourįor more installation options and troubleshooting tips, see To install prebuilt Electron binaries, use npm. This project adheres to the Contributor Covenantīy participating, you are expected to uphold this code. The Electron framework lets you write cross-platform desktop applications View these docs in other languages on our Crowdin project.