No description
Find a file
Sudowoodo Release Bot 690dbb7e62 Revert "Bump v17.0.0-nightly.20211022"
This reverts commit b8ea7bf90b.
2021-10-22 13:22:03 -07:00
.circleci build: add basic codespaces configuration (#30528) 2021-08-16 10:33:49 -07:00
.devcontainer build: fix gclient config file 2021-08-16 10:56:29 -07:00
.github docs: Update Branch Name (#31106) 2021-09-27 11:35:56 -04:00
.husky chore: Update husky v6.0.0 (#28827) 2021-04-29 09:46:15 +02:00
build chore: update E17 node module version (#31282) 2021-10-07 10:25:56 -07:00
buildflags chore: remove deprecated remote module (#25734) 2021-03-09 17:12:40 -08:00
chromium_src chore: bump chromium to 96.0.4664.4 (main) (#31317) 2021-10-21 11:51:36 -07:00
default_app refactor: use PathProvider for user-data-dir and others (#29649) 2021-06-15 09:32:56 +09:00
docs fix: link to image (#31454) 2021-10-19 17:43:10 +09:00
lib fix: add isDestroyed check (#31208) 2021-10-19 09:57:10 +09:00
npm build: embed binary checksums in the npm package (#30611) 2021-08-19 11:26:17 -07:00
patches fix: MediaMetadata not working properly (#31492) 2021-10-21 15:39:38 -04:00
script fix: generate valid config.gypi (#31404) 2021-10-14 10:07:36 -04:00
shell Revert "Bump v17.0.0-nightly.20211022" 2021-10-22 13:22:03 -07:00
spec feat: Add data parameter to app.requestSingleInstanceLock() (#30891) 2021-10-14 21:32:32 -04:00
spec-main feat: Add data parameter to app.requestSingleInstanceLock() (#30891) 2021-10-14 21:32:32 -04:00
typings refactor: only access memory coordinator interface from browser process (#31295) 2021-10-05 15:30:31 -07: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 feat: add webContents.setWindowOpenHandler API (#24517) 2020-11-10 09:06:03 -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 add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
appveyor.yml ci: drop with_tags with_branch_heads from sync on appveyor (#30601) 2021-08-19 09:23:34 -07:00
azure-pipelines-arm.yml ci: enable arm64 macOS tests (#24832) 2021-01-21 18:36:52 -05:00
azure-pipelines-woa.yml ci: ignore pdb download failure (#30785) 2021-09-01 10:26:12 -04:00
BUILD.gn fix: generate valid config.gypi (#31404) 2021-10-14 10:07:36 -04: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 96.0.4664.4 (main) (#31317) 2021-10-21 11:51:36 -07:00
electron_paks.gni chore: media_internal_resources becomes resources 2021-03-04 15:53:46 -08:00
electron_resources.grd feat: add support for the U2F Web API (#30438) 2021-08-30 11:22:46 -07:00
electron_strings.grdp feat: add support for WebHID (#30213) 2021-09-23 20:00:11 +09:00
ELECTRON_VERSION Revert "Bump v17.0.0-nightly.20211022" 2021-10-22 13:22:03 -07:00
filenames.auto.gni docs: add window customization guide (#31054) 2021-10-19 09:58:35 +09:00
filenames.gni feat: add support for WebHID (#30213) 2021-09-23 20:00:11 +09: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 Revert "Bump v17.0.0-nightly.20211022" 2021-10-22 13:22:03 -07:00
README.md docs: Update Branch Name (#31106) 2021-09-27 11:35:56 -04: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 spec: initial spike of main-process based tests 2019-03-14 12:50:06 -07: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 build(deps): bump tar from 4.4.15 to 4.4.19 (#30776) 2021-09-22 08:54:39 +09: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.