No description
Find a file
electron-roller[bot] f4ee3c1b2a
chore: bump node to v20.11.0 (main) (#40941)
* chore: bump node in DEPS to v20.11.0

* module: bootstrap module loaders in shadow realm

https://github.com/nodejs/node/pull/48655

* src: add commit hash shorthand in zlib version

https://github.com/nodejs/node/pull/50158

* v8,tools: expose necessary V8 defines

https://github.com/nodejs/node/pull/50820

* esm: do not call getSource when format is commonjs

https://github.com/nodejs/node/pull/50465

* esm: fallback to readFileSync when source is nullish

https://github.com/nodejs/node/pull/50825

* vm: allow dynamic import with a referrer realm

https://github.com/nodejs/node/pull/50360

* test: skip test-diagnostics-channel-memory-leak.js

https://github.com/nodejs/node/pull/50327

* esm: do not call getSource when format is commonjs

https://github.com/nodejs/node/pull/50465

* lib: fix assert throwing different error messages in ESM and CJS

https://github.com/nodejs/node/pull/50634

* src: fix compatility with upcoming V8 12.1 APIs

https://github.com/nodejs/node/pull/50709

* deps: update base64 to 0.5.1

https://github.com/nodejs/node/pull/50629

* src: avoid silent coercion to signed/unsigned int

https://github.com/nodejs/node/pull/50663

* src: fix compatility with upcoming V8 12.1 APIs

https://github.com/nodejs/node/pull/50709

* chore: fix patch indices

* chore: update patches

* test: disable TLS cipher test

This can't be enabled owing to BoringSSL incompatibilities.

https://github.com/nodejs/node/pull/50186

* fix: check for Buffer and global definition in shadow realm

https://github.com/nodejs/node/pull/51239

* test: disable parallel/test-shadow-realm-custom-loader

Incompatible with our asar logic, resulting in the following failure:

> Failed to CompileAndCall electron script: electron/js2c/asar_bundle

* chore: remove deleted parallel/test-crypto-modp1-error test

* test: make test-node-output-v8-warning generic

https://github.com/nodejs/node/pull/50421

* chore: fixup ModuleWrap patch

* test: match wpt/streams/transferable/transform-stream-members.any.js to upstream

* fix: sandbox is not enabled on arm

* chore: disable v8 sandbox on ia32/arm

---------

Co-authored-by: electron-roller[bot] <84116207+electron-roller[bot]@users.noreply.github.com>
Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>
Co-authored-by: Cheng Zhao <zcbenz@gmail.com>
2024-01-18 16:16:45 -05:00
.circleci ci: correctly export RBE_experimental_credentials_helper_args (#40997) 2024-01-15 19:48:10 +01:00
.devcontainer build: correct codespaces devcontainer extensions settings (#39123) 2023-07-19 00:20:11 +02:00
.github ci: fix missing inputs for release project board automation (#40726) 2024-01-10 13:25:11 +01:00
.husky
build fix: make grant_file_protocol_extra_privileges fuse also block CORS fetches (#40801) 2024-01-02 13:06:33 -08:00
buildflags feat: replace BrowserView with WebContentsView (#35658) 2023-12-13 13:01:03 -08:00
chromium_src chore: bump chromium to 122.0.6194.0 (main) (#40750) 2024-01-03 09:52:49 +01:00
default_app feat: I guess it's esm (#37535) 2023-08-30 17:38:07 -07:00
docs docs: add reclient docs, remove goma docs (#40948) 2024-01-12 13:50:20 +13:00
lib feat: add net module to utility process (#40017) 2024-01-04 16:20:37 -05:00
npm chore: upgrade to Node.js v20 (#40545) 2023-11-30 09:51:35 -05:00
patches chore: bump node to v20.11.0 (main) (#40941) 2024-01-18 16:16:45 -05:00
script chore: bump node to v20.11.0 (main) (#40941) 2024-01-18 16:16:45 -05:00
shell feat: Windows integrity check (#40504) 2024-01-19 09:00:49 +13:00
spec test: fixup assertNotWindows (#41045) 2024-01-18 14:04:43 -05:00
spec-chromium
typings feat: add net module to utility process (#40017) 2024-01-04 16:20:37 -05:00
.clang-format
.clang-tidy chore: fix clang-tidy warnings (#38079) 2023-04-26 10:09:54 -04:00
.dockerignore
.env.example
.eslintrc.json chore: re-enable node/no-deprecated-api linting (#38899) 2023-06-26 13:51:59 -04:00
.git-blame-ignore-revs
.gitattributes build: force LF checkout of more files (#38194) 2023-05-08 17:02:42 +09:00
.gitignore
.markdownlint.autofix.json
.markdownlint.json chore: migrate to @electron/lint-roller for Markdown linting (#38191) 2023-05-08 12:50:42 +02:00
.nvmrc
.remarkrc
appveyor-bake.yml build: add infra for reclient support (#40850) 2024-01-10 10:19:42 +13:00
appveyor-woa.yml build: update appveyor image to latest version (#40951) 2024-01-18 16:08:00 -05:00
appveyor.yml build: update appveyor image to latest version (#40951) 2024-01-18 16:08:00 -05:00
BUILD.gn chore: bump node to v20.11.0 (main) (#40941) 2024-01-18 16:16:45 -05:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md chore: add dependencies upgrade policy to readme (#39163) 2023-07-25 11:58:16 +02:00
DEPS chore: bump node to v20.11.0 (main) (#40941) 2024-01-18 16:16:45 -05:00
electron_paks.gni chore: bump chromium to 119.0.6016.0 (main) (#39898) 2023-09-19 19:34:56 +02:00
electron_resources.grd
filenames.auto.gni feat: add net module to utility process (#40017) 2024-01-04 16:20:37 -05:00
filenames.gni feat: add net module to utility process (#40017) 2024-01-04 16:20:37 -05:00
filenames.hunspell.gni
filenames.libcxx.gni chore: bump chromium to 122.0.6236.2 (main) (#40871) 2024-01-11 19:33:40 +13:00
filenames.libcxxabi.gni chore: bump chromium to 117.0.5938.0 (main) (#39375) 2023-08-15 10:49:41 -05:00
js2c_toolchain.gni chore: upgrade to Node.js v20 (#40545) 2023-11-30 09:51:35 -05:00
LICENSE
package.json build: update typescript-definitions to 8.15.2 (#40670) 2023-12-05 00:53:52 -08:00
README.md docs: replace the example app using electron (#37805) 2023-10-18 10:56:17 -04:00
SECURITY.md
tsconfig.default_app.json feat: I guess it's esm (#37535) 2023-08-30 17:38:07 -07:00
tsconfig.electron.json
tsconfig.json build: specify explicit typeroots for ts builds (#40588) 2023-11-22 09:39:36 -08:00
tsconfig.script.json
tsconfig.spec.json
yarn.lock build: update typescript-definitions to 8.15.2 (#40670) 2023-12-05 00:53:52 -08:00

Electron Logo

CircleCI Build Status AppVeyor 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 (Catalina and up): Electron provides 64-bit Intel and ARM binaries for macOS. Apple Silicon support was added in Electron 11.
  • 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.