No description
Find a file
Jeremy Rose f912130be6
fix: libuv patches to address child_process.spawn slowness (#33337)
* fix: libuv patches to address child_process.spawn slowness

* chore: backport additional patches

Co-authored-by: deepak1556 <hop2deep@gmail.com>
2022-03-23 06:30:54 -07:00
.circleci ci: enable thin LTO on Mac (#33194) 2022-03-22 11:31:53 -04:00
.devcontainer build: fix gclient config file 2021-08-16 10:56:29 -07:00
.github docs: add note about supported versions to issue template (#33348) 2022-03-21 13:51:59 -04:00
.husky chore: Update husky v6.0.0 (#28827) 2021-04-29 09:46:15 +02:00
build build: drop pywin32 usage (#26186) 2022-03-16 13:40:47 -04:00
buildflags chore: remove deprecated remote module (#25734) 2021-03-09 17:12:40 -08:00
chromium_src chore: bump chromium to 100.0.4894.0 (main) (#32852) 2022-02-25 13:17:35 -05:00
default_app chore: update to latest TypeScript (#32596) 2022-01-31 20:37:40 +09:00
docs docs: add new IPC validation section to the security tutorial (#33369) 2022-03-22 20:45:23 -04:00
lib fix: initialize asar support in worker threads (#33216) 2022-03-22 20:37:55 -04:00
npm chore: upgrade @electron/get version to ^1.14.1 (#33259) 2022-03-22 09:41:21 -07:00
patches fix: libuv patches to address child_process.spawn slowness (#33337) 2022-03-23 06:30:54 -07:00
script chore: use pylint-2.7 (#33232) 2022-03-22 20:17:35 -04:00
shell Bump v19.0.0-nightly.20220323 2022-03-23 06:00:58 -07:00
spec fix: initialize asar support in worker threads (#33216) 2022-03-22 20:37:55 -04:00
spec-main fix: initialize asar support in worker threads (#33216) 2022-03-22 20:37:55 -04:00
typings fix: initialize asar support in worker threads (#33216) 2022-03-22 20:37:55 -04:00
.clang-format
.dockerignore build: remove unused install-build-deps (#26891) 2020-12-09 09:26:21 -08:00
.env.example build: do not require vsts token for releases (#28643) 2021-04-13 15:30:46 -07:00
.eslintrc.json feat: add webContents.setWindowOpenHandler API (#24517) 2020-11-10 09:06:03 -08:00
.git-blame-ignore-revs chore: add ignore revs file for GH blame UI (#33171) 2022-03-07 18:40:28 -08:00
.gitattributes chore: force source code and markdown files to use LF line ending (#25134) 2020-08-27 10:25:39 +09:00
.gitignore build: embed binary checksums in the npm package (#30611) 2021-08-19 11:26:17 -07:00
.markdownlint.autofix.json chore: use markdownlint to lint the docs (#26792) 2021-01-14 17:31:26 +09:00
.markdownlint.json fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
.nvmrc build: add nvmrc file (#30612) 2021-08-19 11:12:17 -07:00
.remarkrc
appveyor.yml chore: bump chromium to 100.0.4894.0 (main) (#32852) 2022-02-25 13:17:35 -05:00
azure-pipelines-arm.yml ci: enable arm64 macOS tests (#24832) 2021-01-21 18:36:52 -05:00
azure-pipelines-woa.yml chore: bump chromium to 100.0.4894.0 (main) (#32852) 2022-02-25 13:17:35 -05:00
BUILD.gn chore: bump chromium to 100.0.4894.0 (main) (#32852) 2022-02-25 13:17:35 -05:00
CODE_OF_CONDUCT.md docs: use asterisks for unordered lists (#26552) 2020-11-23 12:15:27 -05:00
CONTRIBUTING.md docs: Update Branch Name (#31106) 2021-09-27 11:35:56 -04:00
DEPS chore: bump chromium to 100.0.4894.0 (main) (#32852) 2022-02-25 13:17:35 -05:00
electron_paks.gni chore: bump chromium to 100.0.4894.0 (main) (#32852) 2022-02-25 13:17:35 -05:00
electron_resources.grd feat: add support for the U2F Web API (#30438) 2021-08-30 11:22:46 -07:00
electron_strings.grdp fix: add resource strings for file selection (#31881) 2021-11-17 14:13:49 -08:00
ELECTRON_VERSION Bump v19.0.0-nightly.20220323 2022-03-23 06:00:58 -07:00
filenames.auto.gni feat: Added missing info to IAP transaction and product structures (#31739) 2022-01-24 08:55:18 -08:00
filenames.gni fix: ensure ElectronBrowser mojo service is only bound to appropriate render frames (#33323) 2022-03-18 19:50:05 -07:00
filenames.hunspell.gni chore: bump chromium to 6d130075d378a64187360ba4e7820 (master) (#24256) 2020-07-13 21:13:34 -04:00
filenames.libcxx.gni chore: bump chromium to 94.0.4584.0 (main) (#30030) 2021-07-26 09:02:16 -07:00
filenames.libcxxabi.gni test: rebuild nan tests with libc++ and libc++abi (#29281) 2021-05-22 11:48:38 -07:00
LICENSE chore: update copyright headers (#27697) 2021-02-12 15:22:41 -08:00
package.json Bump v19.0.0-nightly.20220323 2022-03-23 06:00:58 -07:00
README.md docs: update Ubuntu version used for Linux prebuilt binaries (#33372) 2022-03-23 18:46:45 +09:00
SECURITY.md docs: Update Branch Name (#31106) 2021-09-27 11:35:56 -04:00
tsconfig.default_app.json chore: fix ts config to not complain about extraneous files (#16790) 2019-02-06 15:46:10 -08:00
tsconfig.electron.json chore: fix ts config to not complain about extraneous files (#16790) 2019-02-06 15:46:10 -08:00
tsconfig.json chore: update to latest TypeScript, which has built-in WeakRef declarations (#27425) 2021-01-22 11:25:47 -08:00
tsconfig.script.json build: auto-push patch file changes (#26235) 2020-10-29 14:21:23 -04:00
tsconfig.spec.json chore: update to latest TypeScript (#32596) 2022-01-31 20:37:40 +09:00
vsts-arm-test-steps.yml chore: bump chromium to 92.0.4475.0 (master) (#28462) 2021-04-15 10:44:35 -07:00
vsts-arm32v7.yml build: add basic codespaces configuration (#30528) 2021-08-16 10:33:49 -07:00
vsts-arm64v8.yml build: add basic codespaces configuration (#30528) 2021-08-16 10:33:49 -07:00
yarn.lock chore: bump @electron/docs-parser version (#33346) 2022-03-21 14:17:25 -04:00

Electron Logo

CircleCI Build Status AppVeyor Build Status Electron Discord Invite

📝 Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages at electron/i18n.

The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on Node.js and Chromium and is used by the Atom editor and many other apps.

Follow @ElectronJS on Twitter for important announcements.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to coc@electronjs.org.

Installation

To install prebuilt Electron binaries, use npm. The preferred method is to install Electron as a development dependency in your app:

npm install electron --save-dev

For more installation options and troubleshooting tips, see installation. For info on how to manage Electron versions in your apps, see Electron versioning.

Platform support

Each Electron release provides binaries for macOS, Windows, and Linux.

  • macOS (El Capitan and up): Electron provides 64-bit Intel and ARM binaries for macOS. Apple Silicon support was added in Electron 11.
  • Windows (Windows 7 and up): Electron provides ia32 (x86), x64 (amd64), and arm64 binaries for Windows. Windows on ARM support was added in Electron 5.0.8.
  • Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04. They have also been verified to work on:
    • Ubuntu 14.04 and newer
    • Fedora 24 and newer
    • Debian 8 and newer

Quick start & Electron Fiddle

Use Electron Fiddle to build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and to try out different versions of Electron. It's designed to make the start of your journey with Electron easier.

Alternatively, clone and run the electron/electron-quick-start repository to see a minimal Electron app in action:

git clone https://github.com/electron/electron-quick-start
cd electron-quick-start
npm install
npm start

Resources for learning Electron

Programmatic usage

Most people use Electron from the command line, but if you require electron inside your Node app (not your Electron app) it will return the file path to the binary. Use this to spawn Electron from Node scripts:

const electron = require('electron')
const proc = require('child_process')

// will print something similar to /Users/maf/.../Electron
console.log(electron)

// spawn Electron
const child = proc.spawn(electron)

Mirrors

See the Advanced Installation Instructions to learn how to use a custom mirror.

Documentation translations

We crowdsource translations for our documentation via Crowdin. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, Russian, and Spanish.

Contributing

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.

Community

Info on reporting bugs, getting help, finding third-party tools and sample apps, and more can be found on the Community page.

License

MIT

When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.