Build cross-platform desktop apps with JavaScript, HTML, and CSS ⚛️ https://www.electronjs.org/
 
 
 
 
 
 
Go to file
Shelley Vohr 2a6ad42113
chore: delete unused PrintPreviewMessageHandler (#41841)
2024-04-15 11:34:56 -04:00
.circleci ci: use CircleCI hosted macOS arm64 runners for testing (#41649) 2024-03-21 14:07:18 -04:00
.devcontainer chore: remove 8088 from codespaces port forwarding (#41557) 2024-03-10 18:18:56 +01:00
.github build: fix potential source of errors in issue workflow (#41715) 2024-03-27 09:50:55 -07:00
.husky chore: update husky to v8.0.1 (#34343) 2022-06-01 13:00:48 -04:00
build build: bump NMV to 123 for Electron 30 (#41370) 2024-02-21 10:02:36 -08:00
buildflags build: add flag for setting vendor version (#41247) 2024-02-06 14:23:17 -08:00
chromium_src feat: implement File System API support (#41419) 2024-04-10 22:06:47 +02:00
default_app feat: I guess it's esm (#37535) 2023-08-30 17:38:07 -07:00
docs docs: clarify before `ready` usage (#41849) 2024-04-15 10:38:58 -04:00
lib fix: recognize 'undefined' header value in `ClientRequest` (#41615) 2024-03-27 16:46:07 -07:00
npm chore: upgrade to Node.js v20 (#40545) 2023-11-30 09:51:35 -05:00
patches feat: implement File System API support (#41419) 2024-04-10 22:06:47 +02:00
script build: redundant regex character class in generate-config-gypi.py (#41858) 2024-04-15 11:33:55 -04:00
shell chore: delete unused PrintPreviewMessageHandler (#41841) 2024-04-15 11:34:56 -04:00
spec fix: do not activate app when showing a panel on Mac (#41750) 2024-04-12 14:27:59 +02:00
spec-chromium chore: bump chromium to 109.0.5382.0 (main) (#36057) 2022-10-27 12:37:04 -04:00
typings feat: add `navigationHistory.getEntryAtIndex(int index)` method (#41577) 2024-03-21 14:59:23 -07:00
.clang-format
.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 build: do not require vsts token for releases (#28643) 2021-04-13 15:30:46 -07:00
.eslintrc.json chore: re-enable node/no-deprecated-api linting (#38899) 2023-06-26 13:51:59 -04: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: force LF checkout of more files (#38194) 2023-05-08 17:02:42 +09:00
.gitignore test: fix some broken globs for spec-main (#35439) 2022-08-25 09:36:08 -07:00
.markdownlint.autofix.json chore: use markdownlint to lint the docs (#26792) 2021-01-14 17:31:26 +09:00
.markdownlint.json build: add Markdown lint check for unescaped angle brackets (#41753) 2024-04-04 14:50:35 -04:00
.nvmrc build: update `.nvmrc` Node.js version from 14 to 16 (#35676) 2022-09-15 15:40:18 -07:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
BUILD.gn fix: package <__assertion_handler> as part of libcxx headers (#41830) 2024-04-12 23:50:03 +09:00
CODE_OF_CONDUCT.md docs: use asterisks for unordered lists (#26552) 2020-11-23 12:15:27 -05:00
CONTRIBUTING.md chore: add dependencies upgrade policy to readme (#39163) 2023-07-25 11:58:16 +02:00
DEPS chore: bump chromium to 124.0.6359.0 (main) (#41584) 2024-03-15 14:03:42 -04:00
LICENSE chore: update copyright headers (#27697) 2021-02-12 15:22:41 -08:00
README.md docs: nodejs trademark policy link broken (#41558) 2024-03-21 10:25:35 -04:00
SECURITY.md docs: update SECURITY.md with new GHSA reporting feature (#36367) 2022-11-15 20:02:01 -08:00
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 (#41617) 2024-03-20 11:50:10 -04:00
appveyor.yml build: update appveyor image to latest version (#41617) 2024-03-20 11:50:10 -04:00
electron_paks.gni fix: `chrome://process-internals` failing to load (#41476) 2024-03-07 15:31:16 +01:00
electron_resources.grd chore: use //chrome resources directly (#33626) 2022-04-06 09:34:35 -07:00
filenames.auto.gni feat: implement File System API support (#41419) 2024-04-10 22:06:47 +02:00
filenames.gni feat: implement File System API support (#41419) 2024-04-10 22:06:47 +02: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 124.0.6351.0 (main) (#41514) 2024-03-12 10:15:41 +01: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
package.json build: add Markdown lint check for unescaped angle brackets (#41753) 2024-04-04 14:50:35 -04: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: specify explicit typeroots for ts builds (#40588) 2023-11-22 09:39:36 -08: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 build(deps): bump tar from 6.1.13 to 6.2.1 in the npm_and_yarn group across 1 directory (#41842) 2024-04-12 13:28:37 -07:00

README.md

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.