No description
Find a file
Electron Bot f965b13d74
chore: bump node to v12.16.1 (master) (#22168)
* chore: bump node in DEPS to v12.16.0

* Fixup asar support setup patch

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

* Fixup InternalCallbackScope patch

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

* Fixup GN buildfiles patch

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

* Fixup low-level hooks patch

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

* Fixup globals require patch

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

* Fixup process stream patch

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

* Fixup js2c modification patch

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

* Fixup internal fs override patch

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

* Fixup context-aware warn patch

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

* Fixup Node.js with ltcg config

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

* Fixup oaepLabel patch

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

* Remove redundant ESM test patch

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

* Remove redundant cli flag patch

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

* Update filenames.json

* Remove macro generation in GN build files

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

* Fix some compilation errors upstream

* Add uvwasi to deps

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

* Fix BoringSSL incompatibilities

* Fixup linked module patch

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

* Add missing sources to GN uv build

https://github.com/libuv/libuv/pull/2347

* Patch some uvwasi incompatibilities

* chore: bump Node.js to v12.6.1

* Remove mark_arraybuffer_as_untransferable.patch

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

* Fix uvwasi build failure on win

* Fixup --perf-prof cli option error

* Fixup early cjs module loading

* fix: initialize diagnostics properly

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

* Disable new esm syntax specs

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

* Fixup v8 weakref hook spec

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

* Fix async context timer issue

* Disable monkey-patch-main spec

It relies on https://github.com/nodejs/node/pull/29777, and we don't
override prepareStackTrace.

* Disable new tls specs

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

We don't support much of TLS owing to schisms between BoringSSL and
OpenSSL.

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>
2020-02-24 21:02:04 +00:00
.circleci chore: allow custom node-spec-runner options (#22315) 2020-02-21 20:19:25 +00:00
.github chore: remove teams without write access from CODEOWNERS (#22043) 2020-02-06 11:31:25 -06:00
build chore: update NMV for Electron 10 (#22190) 2020-02-13 13:18:16 -08:00
buildflags feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
chromium_src feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
default_app feat: add a new contextBridge module (#20307) 2019-10-18 12:57:09 -07:00
docs feat: Add OtherItemsProxy TouchBar item (#22270) 2020-02-24 17:55:06 +09:00
lib chore: do not override history methods when rendererprocessreuse is enabled (#22335) 2020-02-24 12:14:11 -08:00
npm fix: npm download failed when define 'npm_config_platform=mas' (#21801) 2020-01-17 14:44:21 +09:00
patches chore: bump node to v12.16.1 (master) (#22168) 2020-02-24 21:02:04 +00:00
script chore: bump node to v12.16.1 (master) (#22168) 2020-02-24 21:02:04 +00:00
shell chore: bump node to v12.16.1 (master) (#22168) 2020-02-24 21:02:04 +00:00
spec fix: emit will-navigate for sandboxed contents (#22188) 2020-02-21 11:08:26 -08:00
spec-main feat: Add OtherItemsProxy TouchBar item (#22270) 2020-02-24 17:55:06 +09:00
tools build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
typings refactor: declare KeyWeakMap<K, V> returned by createIDWeakMap() / createDoubleIDWeakMap() (#21171) 2019-11-21 13:32:31 +01:00
vendor chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.dockerignore build: remove scripts in the tools dir that are unused (#18944) 2019-06-22 22:29:22 -07:00
.env.example build: move Windows release builds to AppVeyor cloud (#18337) 2019-05-23 16:54:34 -04:00
.eslintrc.json chore: lint spec-main (#20835) 2019-11-01 13:37:02 -07:00
.gitattributes chore: force patches to be checked out with LF line endings (#14789) 2018-09-26 02:04:32 +12:00
.gitignore build: make CI faster, magic contained within (#21086) 2019-11-27 16:29:53 -08:00
.gitmodules chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
appveyor.yml ci: enable goma for all testing builds (#21992) 2020-02-06 12:56:18 -05:00
azure-pipelines-woa.yml test: there is only --ci (#20794) 2019-10-30 16:38:21 -07:00
BUILD.gn feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
CONTRIBUTING.md docs: Update Issue Closure in CONTRIBUTING.md (#20545) 2019-10-14 09:40:01 -07:00
DEPS chore: bump node to v12.16.1 (master) (#22168) 2020-02-24 21:02:04 +00:00
electron_paks.gni feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
electron_resources.grd feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
electron_strings.grdp feat: enable builtin spellchecker (#20692) 2019-10-31 13:11:51 -07:00
ELECTRON_VERSION Bump v10.0.0-nightly.20200223 2020-02-23 07:31:25 -08:00
filenames.auto.gni feat: Add OtherItemsProxy TouchBar item (#22270) 2020-02-24 17:55:06 +09:00
filenames.gni fix(extensions): set lowest isolated world id (#22212) 2020-02-24 13:33:58 +09:00
filenames.hunspell.gni chore: bump chromium to 279aeeec3c9fe2237bc31f776f269 (master) (#21521) 2020-01-17 10:41:52 -08:00
LICENSE chore: update license year (#21657) 2020-01-03 11:10:23 -05:00
package.json Bump v10.0.0-nightly.20200223 2020-02-23 07:31:25 -08:00
README.md docs: update README.md (#20644) 2019-10-21 12:14:42 -07:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09: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: convert more files to TypeScript (#18820) 2019-07-17 10:23:52 -07:00
tsconfig.spec.json spec: initial spike of main-process based tests 2019-03-14 12:50:06 -07:00
vsts-arm-test-steps.yml ci: fix crash on arm testing (#21407) 2019-12-05 14:44:02 -08:00
vsts-arm32v7.yml build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
vsts-arm64v8.yml build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
yarn.lock feat: add API for receiving logs from service workers (#20624) 2020-02-20 15:19:06 -08:00

Electron Logo

CircleCI Build Status AppVeyor Build Status devDependency Status

📝 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 [--save-exact]

The --save-exact flag is recommended for Electron prior to version 2, as it does not follow semantic versioning. As of version 2.0.0, Electron follows semver, so you don't need --save-exact flag. For info on how to manage Electron versions in your apps, see Electron versioning.

For more installation options and troubleshooting tips, see installation.

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

Documentation Translations

Find documentation translations in electron/i18n.

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 in the support document.

License

MIT

When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.