:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS
Перейти к файлу
Shelley Vohr c0d9764de9
fix: `webContents.print` parameter validation error (#38614)
2023-06-09 21:41:01 +02:00
.circleci build: actually use m1.large for publish job (#38706) 2023-06-08 23:56:26 -07:00
.devcontainer build: fix Codespaces prebuilds with missing comma (#38052) 2023-04-20 15:41:54 -07:00
.github ci: remove release dependencies workflow (#38646) 2023-06-08 12:33:35 +02:00
.husky chore: update husky to v8.0.1 (#34343) 2022-06-01 13:00:48 -04:00
build build: use m1 hosts to build apple silicon binaries (#38258) 2023-06-07 16:34:02 -07:00
buildflags build: remove enable_run_as_node build flag (#38413) 2023-06-08 16:40:08 -04:00
chromium_src build: remove enable_picture_in_picture build flag (#38620) 2023-06-07 23:56:31 -07:00
default_app fix: override app's desktop name and v8 flags in default-app (#35997) 2022-10-17 10:34:24 +02:00
docs fix: WCO transparent background (#38693) 2023-06-09 09:57:57 -07:00
lib fix: `webContents.print` parameter validation error (#38614) 2023-06-09 21:41:01 +02:00
npm chore: update node types version (#36924) 2023-01-18 14:46:27 +01:00
patches chore: modify patches so we can build other chromium targets (#38637) 2023-06-08 13:30:36 -04:00
script build: upload node checksums before validating them (#38710) 2023-06-09 02:30:26 -07:00
shell fix: WCO transparent background (#38693) 2023-06-09 09:57:57 -07:00
spec fix: `webContents.print` parameter validation error (#38614) 2023-06-09 21:41:01 +02:00
spec-chromium chore: bump chromium to 109.0.5382.0 (main) (#36057) 2022-10-27 12:37:04 -04:00
typings fix: `webContents.print` parameter validation error (#38614) 2023-06-09 21:41:01 +02:00
.clang-format
.clang-tidy chore: fix clang-tidy warnings (#38079) 2023-04-26 10:09:54 -04:00
.dockerignore
.env.example
.eslintrc.json chore: bump chromium to 102.0.4961.0 (main) (#33091) 2022-03-24 21:39:03 -04:00
.git-blame-ignore-revs
.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
.markdownlint.json chore: migrate to @electron/lint-roller for Markdown linting (#38191) 2023-05-08 12:50:42 +02:00
.nvmrc build: update `.nvmrc` Node.js version from 14 to 16 (#35676) 2022-09-15 15:40:18 -07:00
.remarkrc
BUILD.gn build: remove enable_run_as_node build flag (#38413) 2023-06-08 16:40:08 -04:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md chore: enforce consistent Markdown style for strong and emphasis (#37787) 2023-04-03 13:20:10 +02:00
DEPS build: make ReactiveObjC/Mantle deps format consistent (#38450) 2023-05-29 10:44:21 +02:00
LICENSE
README.md chore: update README.md (#37002) 2023-01-26 09:57:20 +09:00
SECURITY.md docs: update SECURITY.md with new GHSA reporting feature (#36367) 2022-11-15 20:02:01 -08:00
appveyor-bake.yml chore: bump chromium to 113.0.5636.0 (main) (#37130) 2023-03-10 10:07:42 -06:00
appveyor-woa.yml build: fix doc-only early exit on Appveyor (#38547) 2023-06-01 10:40:35 -04:00
appveyor.yml build: fix doc-only early exit on Appveyor (#38547) 2023-06-01 10:40:35 -04:00
electron_paks.gni chore: bump chromium to 115.0.5760.0 (main) (#38033) 2023-05-10 10:47:48 -04:00
electron_resources.grd chore: use //chrome resources directly (#33626) 2022-04-06 09:34:35 -07:00
filenames.auto.gni refactor: split clipboard module implementation for browser / renderer (#38429) 2023-05-25 20:36:12 +09:00
filenames.gni build: remove enable_run_as_node build flag (#38413) 2023-06-08 16:40:08 -04: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 115.0.5760.0 (main) (#38033) 2023-05-10 10:47:48 -04:00
filenames.libcxxabi.gni chore: bump chromium to 102.0.4961.0 (main) (#33091) 2022-03-24 21:39:03 -04:00
package.json chore: type check JS in docs (#38423) 2023-06-05 16:26:26 +09:00
tsconfig.default_app.json
tsconfig.electron.json
tsconfig.json
tsconfig.script.json
tsconfig.spec.json test: drop now-empty remote runner (#35343) 2022-08-16 15:23:13 -04:00
yarn.lock chore: type check JS in docs (#38423) 2023-06-05 16:26:26 +09: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 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.

Platform support

Each Electron release provides binaries for macOS, Windows, and Linux.

  • macOS (High Sierra 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 14.04 and newer
    • Fedora 24 and newer
    • Debian 8 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('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.