No description
Find a file
Calvin f15fa56e38
refactor: reduce & remove no-op MicrotasksScope calls (#46681)
* fix: do not run microtasks in V8Serializer in browser process

* Remove no-op MicrotasksScope in `shell/browser/api/electron_api_auto_updater.cc`

This call was added in https://github.com/electron/electron/pull/40576 as an expansion of `gin_helper::EmitEvent`.

Since this only runs in the browser process and `bool ignore_browser_checkpoint = true` this code is a no-op.

Node should perform a microtask checkpoint if necessary in `node::MakeCallback`.

* Remove no-op MicrotasksScope in `shell/common/api/electron_bindings.cc`

This method is only called by the browser process. The containing function, `ElectronBindings::DidReceiveMemoryDump`, is only used in two places:

* `ElectronBindings::GetProcessMemoryInfo` in the same file, which has a `CHECK` that it's running in the browser process at the top.
* From `shell/browser/api/electron_api_web_contents.cc`, which is only run in the browser process.

Added a DCHECK for clarity and validation.

* Replace `gin_helper::MicrotasksScope` with `v8::MicrotasksScope` in `shell/renderer/`

The browser check is unnecessary in the renderer. Since `gin_helper::MicrotasksScope` will always act exactly like `v8::MicrotasksScope`, it's clear to just use the v8 object directly. This also brings them in line with the many other uses of `v8::MicrotasksScope` in `shell/renderer/`.
2025-04-19 12:18:03 -05:00
.devcontainer build: roll build-images (#46625) 2025-04-14 16:10:46 -04:00
.github build: update build tools (#46656) 2025-04-17 10:32:17 +02:00
.husky chore: update husky to v8.0.1 (#34343) 2022-06-01 13:00:48 -04:00
build chore: move build files to build/ dir (#46368) 2025-04-01 13:42:14 +02:00
buildflags build: add flag for setting vendor version (#41247) 2024-02-06 14:23:17 -08:00
chromium_src feat: support Web Serial & WebUSB blocklists (#46600) 2025-04-17 20:34:34 +02:00
default_app docs: added upstream doc links for node, chromium, and v8 in default_app (#45392) 2025-02-22 10:15:36 -06:00
docs feat: support Web Serial & WebUSB blocklists (#46600) 2025-04-17 20:34:34 +02:00
lib fix: handle potential missing close event property (#46605) 2025-04-11 13:07:26 -04:00
npm build: reland bump Node.js to v22.9.0 (#44597) 2024-11-13 15:34:30 +01:00
patches fix: backgroundMaterial on initial activate (#46657) 2025-04-17 20:34:45 +02:00
script test: fix node spec disabled tests (#46627) 2025-04-14 11:38:27 -04:00
shell refactor: reduce & remove no-op MicrotasksScope calls (#46681) 2025-04-19 12:18:03 -05:00
spec fix: postMessage crash with invalid transferrable (#46639) 2025-04-17 15:09:48 +02:00
spec-chromium chore: bump chromium to 129.0.6650.0 (main) (#43266) 2024-08-12 10:28:33 +02:00
typings fix: remove obsoleted --inspect-brk logic (#46560) 2025-04-09 15:35:40 +02:00
.autofix.markdownlint-cli2.jsonc chore: use markdownlint-cli2 directly for linting Markdown (#42192) 2024-05-15 14:44:46 -04:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.clang-tidy chore: fix clang-tidy warnings (#38079) 2023-04-26 10:09:54 -04:00
.dockerignore build: remove unused install-build-deps (#26891) 2020-12-09 09:26:21 -08:00
.env.example chore: remove remaining references to AppVeyor (#45339) 2025-02-07 12:57:36 +01:00
.eslintrc.json build: add import/order eslint rule (#44085) 2024-10-02 19:10:44 -07:00
.git-blame-ignore-revs chore: add ignore revs file for GH blame UI (#33171) 2022-03-07 18:40:28 -08:00
.gitattributes build: use github actions for windows (#44136) 2024-12-12 11:51:24 -05:00
.gitignore build: use github actions for windows (#44136) 2024-12-12 11:51:24 -05:00
.lint-roller.json chore: update @electron/lint-roller to 2.1.0 (#42078) 2024-05-10 11:00:15 +02:00
.markdownlint-cli2.jsonc docs: add custom titlebar example (#43693) 2024-11-01 11:04:37 -04:00
.nvmrc build: bump version in .nvmrc to 20 (#42668) 2024-06-27 13:46:11 +02:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
BUILD.gn chore: move build files to build/ dir (#46368) 2025-04-01 13:42:14 +02:00
CODE_OF_CONDUCT.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
CONTRIBUTING.md docs: added missing period for consistency and readability (#45333) 2025-02-13 10:55:43 +01:00
DEPS chore: bump chromium to 136.0.7095.0 (main) (#46118) 2025-04-03 19:02:49 -05:00
filenames.auto.gni feat: Corner Smoothing CSS rule (Reland) (#46278) 2025-03-31 11:22:23 -05:00
filenames.gni feat: Corner Smoothing CSS rule (Reland) (#46278) 2025-03-31 11:22:23 -05:00
filenames.hunspell.gni chore: bump chromium to 102.0.4961.0 (main) (#33091) 2022-03-24 21:39:03 -04:00
filenames.libcxx.gni chore: bump chromium to 135.0.7035.0 (main) (#45764) 2025-02-25 15:16:15 -05:00
filenames.libcxxabi.gni chore: bump chromium to 117.0.5938.0 (main) (#39375) 2023-08-15 10:49:41 -05:00
LICENSE chore: update copyright headers (#27697) 2021-02-12 15:22:41 -08:00
package.json fix: remove File.path from types (#46005) 2025-03-21 08:40:49 +01:00
README.md chore: remove remaining references to AppVeyor (#45339) 2025-02-07 12:57:36 +01:00
SECURITY.md docs: update SECURITY.md with new GHSA reporting feature (#36367) 2022-11-15 20:02:01 -08:00
tsconfig.default_app.json feat: I guess it's esm (#37535) 2023-08-30 17:38:07 -07: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 build: update some build dependencies (#43882) 2024-09-26 00:12:11 -07:00
tsconfig.script.json build: auto-push patch file changes (#26235) 2020-10-29 14:21:23 -04:00
tsconfig.spec.json test: drop now-empty remote runner (#35343) 2022-08-16 15:23:13 -04:00
yarn.lock fix: remove File.path from types (#46005) 2025-03-21 08:40:49 +01:00

Electron Logo

GitHub Actions Build Status Electron Discord Invite

📝 Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages on our Crowdin project.

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 Visual Studio Code 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 (Big Sur and up): Electron provides 64-bit Intel and Apple Silicon / ARM binaries for macOS.
  • Windows (Windows 10 and up): Electron provides ia32 (x86), x64 (amd64), and arm64 binaries for Windows. Windows on ARM support was added in Electron 5.0.8. Support for Windows 7, 8 and 8.1 was removed in Electron 23, in line with Chromium's Windows deprecation policy.
  • Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04. They have also been verified to work on:
    • Ubuntu 18.04 and newer
    • Fedora 32 and newer
    • Debian 10 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('node: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.