No description
Find a file
Birunthan Mohanathas cd407d1c3f Stop overwriting prevent_default if default wasn't prevented
This didn't actually cause any issues because there is only one listener
for the affected methods right now. Should we have added more, the last
called observer would have overwritten `prevent_default`. Lets only set
it when necessary to avoid this footgun in the future.
2018-04-19 12:45:21 +02:00
.circleci Use CircleCI for Mac builds (#12572) 2018-04-09 14:19:54 -05:00
.github Update trop whitelist (#12642) 2018-04-18 01:23:03 +10:00
atom Stop overwriting prevent_default if default wasn't prevented 2018-04-19 12:45:21 +02:00
brightray format previously misses .cc files 2018-04-17 21:56:12 -04:00
chromium_src remove unnecessary ptr_util.h include 2018-04-12 22:34:26 -04:00
default_app Replace default_app icon 2017-12-07 16:10:45 -05:00
docs Merge pull request #11328 from electron/add-env-to-release-docs 2018-04-18 11:28:16 -04:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib Make Menu API accept TopLevelWindow 2018-04-19 13:08:37 +09:00
npm Provide an easy way to use a local build of Electron (#12426) 2018-03-25 00:03:17 -04:00
script chore(build): support generating compilation db (#12104) 2018-04-09 14:54:14 +09:00
spec Enable WebFrame method forwarding in sandboxed renderers (#12538) 2018-04-12 11:57:40 +10:00
tools tools: pass custom template for js2c (#12593) 2018-04-13 08:20:04 -04:00
vendor tools: pass custom template for js2c (#12593) 2018-04-13 08:20:04 -04:00
.clang-format
.dockerignore Add testing for arm, arm64 and ia32 linux builds 2017-12-20 11:54:52 -05:00
.gitignore chore(build): support generating compilation db (#12104) 2018-04-09 14:54:14 +09:00
.gitmodules Move brightray submodules to root vendor 2017-05-10 13:27:22 -07:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
.travis.yml Add arm64 task in travis ci 2017-08-22 10:02:51 +09:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
common.gypi pull up definition and remove include 2018-04-14 21:23:05 -04:00
CONTRIBUTING.md add docs/development/README.md (#12373) 2018-03-20 15:36:48 -04:00
Dockerfile Update CI to use Node 8 2018-03-19 10:19:32 -04:00
Dockerfile.arm64 Newer CI images (#12188) 2018-03-08 22:07:50 -05:00
Dockerfile.arm64v8 Update CI to use Node 8 2018-03-19 10:19:32 -04:00
Dockerfile.armv7 Update CI to use Node 8 2018-03-19 10:19:32 -04:00
Dockerfile.circleci Update CI to use Node 8 2018-03-19 10:19:32 -04:00
electron.gyp move pdf viewer behind feature flag 2018-03-20 10:13:17 +03:00
features.gypi fixes offscreen rendering issues 2018-03-20 10:13:17 +03:00
filenames.gypi Expose TopLevelWindow to JavaScript 2018-04-19 13:08:36 +09:00
Jenkinsfile Add 1 hour timeout 2017-12-04 13:19:51 -05:00
Jenkinsfile.arm64 Update CI to use Node 8 2018-03-19 10:19:32 -04:00
LICENSE Update license year 2018-01-01 00:51:40 +01:00
package.json Enable easy rebuild of native modules for unreleased electron (#12217) 2018-03-14 12:59:18 +09:00
README.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
SECURITY.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
toolchain.gypi Fix error when cross compilation 2018-02-23 10:22:00 +09:00

Electron Logo

CircleCI Build Status AppVeyor Build Status Jenkins Build Status devDependency Status Join the Electron Community on Slack

📝 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 as Electron does not follow semantic versioning. 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

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.

Community

You can ask questions and interact with the community in the following locations:

Check out awesome-electron for a community maintained list of useful example apps, tools and resources.

License

MIT

When using the Electron or other GitHub logos, be sure to follow the GitHub logo guidelines.