No description
Find a file
Electron Bot 767b4973a3 Revert "Bump v15.0.0-nightly.20210707"
This reverts commit 5f1233cdad.
2021-07-07 12:11:40 -07:00
.circleci chore: set python interpreter to python3 in script/spec-runner.js (#29740) 2021-06-29 15:46:12 -07:00
.github chore: add wg-security as required reviewer for other files with IPC handlers (#29092) 2021-05-12 12:04:06 -07:00
.husky chore: Update husky v6.0.0 (#28827) 2021-04-29 09:46:15 +02:00
build fix: disable CET as v8 deoptimization is incompatible with it (#29689) 2021-06-16 09:57:58 -07:00
buildflags chore: remove deprecated remote module (#25734) 2021-03-09 17:12:40 -08:00
chromium_src chore: bump chromium to 93.0.4550.0 (main) (#29751) 2021-06-22 12:17:16 -07:00
default_app refactor: use PathProvider for user-data-dir and others (#29649) 2021-06-15 09:32:56 +09:00
docs docs: mention contextIsolation in ipc-main example (#29918) 2021-07-06 10:27:35 -07:00
lib fix: self.module.paths not working in web workers (#29955) 2021-07-05 08:48:46 +09:00
npm fix: download the arm64 version of Electron when running node under rosetta (#29953) 2021-07-06 10:40:26 +09:00
patches chore: bump chromium to 93.0.4566.0 (main) (#29980) 2021-07-06 08:17:13 -04:00
script chore: bump chromium to 93.0.4566.0 (main) (#29980) 2021-07-06 08:17:13 -04:00
shell Revert "Bump v15.0.0-nightly.20210707" 2021-07-07 12:11:40 -07:00
spec chore: bump chromium to 93.0.4566.0 (main) (#29980) 2021-07-06 08:17:13 -04:00
spec-main fix: self.module.paths not working in web workers (#29955) 2021-07-05 08:48:46 +09:00
typings chore: remove unused and broken ipcRendererInternal.sendTo() (#29743) 2021-06-17 23:26:18 -05:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.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
.gitattributes chore: force source code and markdown files to use LF line ending (#25134) 2020-08-27 10:25:39 +09:00
.gitignore build: remove the vendor directory (#28883) 2021-04-28 00:38:08 -07:00
.markdownlint.autofix.json
.markdownlint.json fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
appveyor.yml build: enable woa testing (#28952) 2021-05-03 09:53:51 -04:00
azure-pipelines-arm.yml
azure-pipelines-woa.yml ci: ignore errors deleting user app directories on WOA testing (#27709) 2021-02-15 09:44:32 +09:00
BUILD.gn chore: bump chromium to 93.0.4566.0 (main) (#29980) 2021-07-06 08:17:13 -04:00
CODE_OF_CONDUCT.md docs: use asterisks for unordered lists (#26552) 2020-11-23 12:15:27 -05:00
CONTRIBUTING.md chore: tidy up markdown (#26554) 2020-11-18 20:58:47 -08:00
DEPS chore: bump chromium to 93.0.4566.0 (main) (#29980) 2021-07-06 08:17:13 -04:00
electron_paks.gni
electron_resources.grd feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
electron_strings.grdp chore: bump chromium to 92.0.4475.0 (master) (#28462) 2021-04-15 10:44:35 -07:00
ELECTRON_VERSION Revert "Bump v15.0.0-nightly.20210707" 2021-07-07 12:11:40 -07:00
filenames.auto.gni refactor: implement <webview> using contextBridge (#29037) 2021-05-15 16:42:07 +09:00
filenames.gni feat: bring --enable-logging functionality in line with Chromium (#25089) 2021-06-17 14:17:25 -07:00
filenames.hunspell.gni
filenames.libcxx.gni chore: bump chromium to 93.0.4566.0 (main) (#29980) 2021-07-06 08:17:13 -04:00
filenames.libcxxabi.gni test: rebuild nan tests with libc++ and libc++abi (#29281) 2021-05-22 11:48:38 -07:00
LICENSE
package.json Revert "Bump v15.0.0-nightly.20210707" 2021-07-07 12:11:40 -07:00
README.md docs: remove devDependencies badge from README (#29499) 2021-06-03 09:44:48 -07:00
SECURITY.md chore: tidy up markdown (#26554) 2020-11-18 20:58:47 -08:00
tsconfig.default_app.json
tsconfig.electron.json
tsconfig.json
tsconfig.script.json
tsconfig.spec.json
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 chore: set python interpreter to python3 in script/spec-runner.js (#29740) 2021-06-29 15:46:12 -07:00
vsts-arm64v8.yml chore: set python interpreter to python3 in script/spec-runner.js (#29740) 2021-06-29 15:46:12 -07:00
yarn.lock fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07: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.

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.