:electron: Build cross-platform desktop apps with JavaScript, HTML, and CSS
Перейти к файлу
trop[bot] d9d6ba180c
fix: bugprone-narrowing-conversions warnings in NativeImage (#44739)
* fix: bugprone-narrowing-conversions warning in NativeImage::memory_usage_

- fix signed / unsigned math by using base/numerics/safe_conversions

- make memory_usage_ an int64_t so it can safely take the size_t
  returned by computeByteSize()

---------

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Charles Kerr <charles@charleskerr.com>
2024-11-20 11:15:22 -06:00
.devcontainer build: update devcontainer sha (#44244) 2024-10-15 10:19:55 -04:00
.github build: add new status to verify if all the required gha jobs have run (#44555) 2024-11-04 16:41:40 -05:00
.husky chore: update husky to v8.0.1 (#34343) 2022-06-01 13:00:48 -04:00
build build: fix python warnings "SyntaxWarning: invalid escape sequence '\w'" (#44659) 2024-11-14 07:28:13 -06:00
buildflags build: add flag for setting vendor version (#41247) 2024-02-06 14:23:17 -08:00
chromium_src fix: add theme data source for devtools.(32-x-y) (#44639) 2024-11-14 12:45:08 +01:00
default_app build: add import/order eslint rule (#44107) 2024-10-02 21:36:15 -07:00
docs fix: `utilityProcess` pid should be `undefined` after exit (#44693) 2024-11-18 13:43:23 -06:00
lib fix: EventSource undefined in Renderer/Worker (#44497) 2024-10-31 16:44:00 -05:00
npm build: add import/order eslint rule (#44107) 2024-10-02 21:36:15 -07:00
patches fix: utility process exit code for graceful termination (#44749) 2024-11-20 23:23:10 +09:00
script build: fix python warnings "SyntaxWarning: invalid escape sequence '\w'" (#44659) 2024-11-14 07:28:13 -06:00
shell fix: bugprone-narrowing-conversions warnings in NativeImage (#44739) 2024-11-20 11:15:22 -06:00
spec fix: utility process exit code for graceful termination (#44749) 2024-11-20 23:23:10 +09:00
spec-chromium chore: bump chromium to 109.0.5382.0 (main) (#36057) 2022-10-27 12:37:04 -04:00
typings build: update some build dependencies (#44070) 2024-10-01 13:04:53 -07:00
.autofix.markdownlint-cli2.jsonc chore: use markdownlint-cli2 directly for linting Markdown (#42192) 2024-05-15 14:44:46 -04:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.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: remove CircleCI (#42844) (#42908) 2024-07-15 14:56:53 -07:00
.eslintrc.json build: add import/order eslint rule (#44107) 2024-10-02 21:36:15 -07:00
.git-blame-ignore-revs chore: add ignore revs file for GH blame UI (#33171) 2022-03-07 18:40:28 -08:00
.gitattributes chore: fix `npm run lint` not working on Windows (#42905) 2024-07-16 12:32:12 +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 docs: add custom titlebar example (#44508) 2024-11-01 14:02:42 -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: replace deprecated libnotify API calls (#43984) 2024-09-26 17:08:20 -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 128.0.6613.186 (32-x-y) (#44162) 2024-10-09 12:36:07 -04:00
LICENSE chore: update copyright headers (#27697) 2021-02-12 15:22:41 -08:00
README.md build: remove CircleCI (#42844) (#42908) 2024-07-15 14:56:53 -07: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 chore: fixup reclient read only access on forks (#44306) 2024-10-17 22:21:23 -04:00
appveyor.yml chore: fixup reclient read only access on forks (#44306) 2024-10-17 22:21:23 -04:00
electron_paks.gni chore: bump chromium to 128.0.6571.0 (32-x-y) (#42767) 2024-07-03 15:58:15 -04:00
electron_resources.grd chore: use //chrome resources directly (#33626) 2022-04-06 09:34:35 -07:00
filenames.auto.gni feat: add transparency checking to `nativeTheme` (#43024) 2024-07-24 22:16:00 +02:00
filenames.gni fix: add theme data source for devtools.(32-x-y) (#44639) 2024-11-14 12:45:08 +01: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 128.0.6611.0 (32-x-y) (#43017) 2024-07-25 11:24:11 +02: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: remove unused lint package (#44532) 2024-11-04 09:06:02 -05: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: update some build dependencies (#44070) 2024-10-01 13:04:53 -07: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: remove unused lint package (#44532) 2024-11-04 09:06:02 -05:00

README.md

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 (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.