No description
Find a file
bitdisaster 89eb309d0b
feat: allow GUID parameter to avoid systray demotion on Windows (#21891)
* fix: systray icon demotion

Adding support for GUID parameter in Tray API.
In combination with signed binaries this allows to maintain
the position in the systray on Windows.

* unit tests

* make mac and linux compile
2020-01-31 14:37:03 +09:00
.circleci ci: use goma for windows and linux builds (#21868) 2020-01-23 09:47:38 -08:00
.github chore: delete the security issue template (#21344) 2019-12-01 15:23:31 -08:00
build chore: bump chromium to 279aeeec3c9fe2237bc31f776f269 (master) (#21521) 2020-01-17 10:41:52 -08:00
buildflags fix: use the new MediaPlayPause key listener for internal chrome logic (#21959) 2020-01-29 18:18:59 -08:00
chromium_src chore: bump chromium to 4b6692e4cc2839729bb7ac009586a (master) (#21864) 2020-01-29 07:01:37 -05:00
default_app feat: add a new contextBridge module (#20307) 2019-10-18 12:57:09 -07:00
docs feat: allow GUID parameter to avoid systray demotion on Windows (#21891) 2020-01-31 14:37:03 +09:00
lib update (#21915) 2020-01-29 18:42:25 +09:00
npm fix: npm download failed when define 'npm_config_platform=mas' (#21801) 2020-01-17 14:44:21 +09:00
patches fix: use the new MediaPlayPause key listener for internal chrome logic (#21959) 2020-01-29 18:18:59 -08:00
script chore: fix linter errors in .mm files (#21931) 2020-01-29 17:03:53 +00:00
shell feat: allow GUID parameter to avoid systray demotion on Windows (#21891) 2020-01-31 14:37:03 +09:00
spec chore: bump chromium to 4b6692e4cc2839729bb7ac009586a (master) (#21864) 2020-01-29 07:01:37 -05:00
spec-main feat: allow GUID parameter to avoid systray demotion on Windows (#21891) 2020-01-31 14:37:03 +09:00
tools build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
typings refactor: declare KeyWeakMap<K, V> returned by createIDWeakMap() / createDoubleIDWeakMap() (#21171) 2019-11-21 13:32:31 +01:00
vendor chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.dockerignore build: remove scripts in the tools dir that are unused (#18944) 2019-06-22 22:29:22 -07:00
.env.example build: move Windows release builds to AppVeyor cloud (#18337) 2019-05-23 16:54:34 -04:00
.eslintrc.json chore: lint spec-main (#20835) 2019-11-01 13:37:02 -07:00
.gitattributes chore: force patches to be checked out with LF line endings (#14789) 2018-09-26 02:04:32 +12:00
.gitignore build: make CI faster, magic contained within (#21086) 2019-11-27 16:29:53 -08:00
.gitmodules chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
appveyor.yml ci: Use Windows VM initialized via script (#21882) 2020-01-27 21:45:04 -05:00
azure-pipelines-woa.yml test: there is only --ci (#20794) 2019-10-30 16:38:21 -07:00
BUILD.gn chore: bump chromium to 4b6692e4cc2839729bb7ac009586a (master) (#21864) 2020-01-29 07:01:37 -05:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
CONTRIBUTING.md docs: Update Issue Closure in CONTRIBUTING.md (#20545) 2019-10-14 09:40:01 -07:00
DEPS chore: bump chromium to 669e1d2c51901c686b055da965f2d (master) (#21954) 2020-01-29 16:45:08 -05:00
electron_paks.gni chore: bump chromium to b243c83a66a7fded00f3408107778 (master) (#21827) 2020-01-21 09:39:37 -08:00
electron_resources.grd chore: use c++ manifests instead of json 2019-02-14 23:59:26 +05:30
electron_strings.grdp feat: enable builtin spellchecker (#20692) 2019-10-31 13:11:51 -07:00
ELECTRON_VERSION Bump v9.0.0-nightly.20200130 2020-01-30 07:32:53 -08:00
filenames.auto.gni docs: move breaking changes out of API folder (#21870) 2020-01-28 22:19:18 +00:00
filenames.gni chore: bump chromium to 279aeeec3c9fe2237bc31f776f269 (master) (#21521) 2020-01-17 10:41:52 -08:00
filenames.hunspell.gni chore: bump chromium to 279aeeec3c9fe2237bc31f776f269 (master) (#21521) 2020-01-17 10:41:52 -08:00
LICENSE chore: update license year (#21657) 2020-01-03 11:10:23 -05:00
package.json Bump v9.0.0-nightly.20200130 2020-01-30 07:32:53 -08:00
README.md docs: update README.md (#20644) 2019-10-21 12:14:42 -07:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09: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: convert more files to TypeScript (#18820) 2019-07-17 10:23:52 -07: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 ci: fix crash on arm testing (#21407) 2019-12-05 14:44:02 -08:00
vsts-arm32v7.yml build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
vsts-arm64v8.yml build: use autogenerated docker images for CI runs (#21056) 2019-11-13 14:29:15 +09:00
yarn.lock chore: upgrade ts generator for better type safety (#20975) 2019-11-05 13:34:04 -08:00

Electron Logo

CircleCI Build Status AppVeyor Build Status devDependency Status

📝 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 [--save-exact]

The --save-exact flag is recommended for Electron prior to version 2, as it does not follow semantic versioning. As of version 2.0.0, Electron follows semver, so you don't need --save-exact flag. For info on how to manage Electron versions in your apps, see Electron versioning.

For more installation options and troubleshooting tips, see installation.

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.