No description
Find a file
trop[bot] 633cec167e
fix: crash when generating shortcut text for super accelerator (#44346)
Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: deepak1556 <hop2deep@gmail.com>
Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>
2024-10-22 19:21:40 +02:00
.devcontainer build: update devcontainer sha (#44229) 2024-10-15 10:35:43 +02:00
.github build: fixup reclient use for prod builds (#44345) 2024-10-21 17:15:13 -04:00
.husky chore: update husky to v8.0.1 (#34343) 2022-06-01 13:00:48 -04:00
build build: update NMV to 132 (#44135) 2024-10-09 11:55:59 -07:00
buildflags build: add flag for setting vendor version (#41247) 2024-02-06 14:23:17 -08:00
chromium_src chore: bump chromium to 131.0.6776.0 (main) (#44137) 2024-10-15 11:51:11 -04:00
default_app chore: bump chromium to 131.0.6776.0 (main) (#44137) 2024-10-15 11:51:11 -04:00
docs docs: add section on resource management to base-window.md (#43610) 2024-10-15 11:49:54 -04:00
lib feat: add WebFrameMain detached property (#43473) 2024-10-11 18:33:53 -04:00
npm build: add import/order eslint rule (#44085) 2024-10-02 19:10:44 -07:00
patches fix: crash when generating shortcut text for super accelerator (#44346) 2024-10-22 19:21:40 +02:00
script build: remove dead code in prepare release script (#44286) 2024-10-16 17:37:11 -04:00
shell chore: bump chromium to 132.0.6789.1 (34-x-y) (#44328) 2024-10-21 10:50:20 -04:00
spec fix: crash when generating shortcut text for super accelerator (#44346) 2024-10-22 19:21:40 +02:00
spec-chromium chore: bump chromium to 129.0.6650.0 (main) (#43266) 2024-08-12 10:28:33 +02:00
typings feat: add WebFrameMain detached property (#43473) 2024-10-11 18:33:53 -04:00
.autofix.markdownlint-cli2.jsonc chore: use markdownlint-cli2 directly for linting Markdown (#42192) 2024-05-15 14:44:46 -04:00
.clang-format
.clang-tidy chore: fix clang-tidy warnings (#38079) 2023-04-26 10:09:54 -04:00
.dockerignore
.env.example build: remove CircleCI (#42844) 2024-07-15 14:26:41 -04:00
.eslintrc.json build: add import/order eslint rule (#44085) 2024-10-02 19:10:44 -07:00
.git-blame-ignore-revs
.gitattributes chore: fix npm run lint not working on Windows (#42281) 2024-07-15 18:08:33 +02:00
.gitignore test: fix some broken globs for spec-main (#35439) 2022-08-25 09:36:08 -07:00
.lint-roller.json chore: update @electron/lint-roller to 2.1.0 (#42078) 2024-05-10 11:00:15 +02:00
.markdownlint-cli2.jsonc chore: update @electron/lint-roller to 2.2.0 (#42412) 2024-06-10 10:14:03 -05:00
.nvmrc build: bump version in .nvmrc to 20 (#42668) 2024-06-27 13:46:11 +02:00
.remarkrc
appveyor-bake.yml build: use node 20.17 on Windows (#44065) 2024-10-02 20:12:41 +02:00
appveyor-woa.yml build: update appveyor image to latest version (#44362) 2024-10-22 12:37:46 -04:00
appveyor.yml build: update appveyor image to latest version (#44362) 2024-10-22 12:37:46 -04:00
BUILD.gn fix: FTBFS when building with enable_plugins = false (#44003) 2024-09-29 17:10:34 -05:00
CODE_OF_CONDUCT.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
CONTRIBUTING.md chore: add dependencies upgrade policy to readme (#39163) 2023-07-25 11:58:16 +02:00
DEPS chore: bump chromium to 132.0.6789.1 (34-x-y) (#44328) 2024-10-21 10:50:20 -04:00
electron_paks.gni chore: bump chromium to 128.0.6571.0 (main) (#42749) 2024-07-03 11:15:35 -04:00
electron_resources.grd chore: use //chrome resources directly (#33626) 2022-04-06 09:34:35 -07:00
filenames.auto.gni feat: GPU shared texture offscreen rendering (#42953) 2024-08-22 19:23:13 -05:00
filenames.gni fix: -Wunsafe-buffer-usage warning in ChunkedDataPipeReadableStream (#44211) 2024-10-14 10:46:24 +02:00
filenames.hunspell.gni
filenames.libcxx.gni chore: bump chromium to 131.0.6776.0 (main) (#44137) 2024-10-15 11:51:11 -04: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 ts defs and docs parser (#43985) 2024-10-11 10:44:18 -04:00
README.md chore: bump chromium to 129.0.6630.0 (main) (#43087) 2024-08-02 09:02:11 -05:00
SECURITY.md docs: update SECURITY.md with new GHSA reporting feature (#36367) 2022-11-15 20:02:01 -08:00
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: update some build dependencies (#43882) 2024-09-26 00:12:11 -07:00
tsconfig.script.json
tsconfig.spec.json test: drop now-empty remote runner (#35343) 2022-08-16 15:23:13 -04:00
yarn.lock build: update ts defs and docs parser (#43985) 2024-10-11 10:44:18 -04:00

Electron Logo

GitHub Actions 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 (Big Sur and up): Electron provides 64-bit Intel and Apple Silicon / ARM binaries for macOS.
  • 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.