No description
Find a file
Shelley Vohr ffb53405fb
chore: convert extension apis to TypeScript (#18688)
Converts extensions-related files to TS
2019-06-14 07:52:24 -07:00
.circleci build: unify YARN_VERSION variable usage and ensure CI uses yarn not npm (#18607) 2019-06-05 16:30:39 -07:00
.github chore: remove extra colon in Issue Details (#18359) 2019-05-21 15:45:03 +09:00
atom fix: crash in BrowserWindow destructor after win.webContents.destroy() (#18686) 2019-06-14 11:44:36 +09:00
build build: remove Vulkan mock ICD (#18546) 2019-06-03 20:17:57 +02:00
buildflags fix: port OSR code to new viz compositor codepath (#17538) 2019-04-17 14:10:04 -07:00
chromium_src chore: remove last instances of base::Bind (#18178) 2019-05-29 13:02:15 -07:00
components/pepper_flash chore: fix linking errors on Windows 2019-02-14 23:59:26 +05:30
default_app refactor: use ipcRenderer.invoke / ipcMain.handle in default-app (#18581) 2019-06-04 18:13:35 +02:00
docs docs: fix invalid optional declaration (#18780) 2019-06-13 15:56:03 -07:00
docs-translations update references to renamed i18n repo 2018-03-02 12:05:49 -08:00
lib chore: convert extension apis to TypeScript (#18688) 2019-06-14 07:52:24 -07:00
native_mate docs: replace the atom.io headers URL with electronjs.org (#18328) 2019-05-21 16:17:07 +09:00
npm chore: update the npm package to use @electron/get (#18413) 2019-05-24 13:40:53 -07:00
patches fix: use crashpad on Windows (#18483) 2019-06-13 15:42:21 +09:00
script refactor: mojofy autofill (#18723) 2019-06-12 15:08:22 -07:00
spec ci: make console.warn work in tests (#18771) 2019-06-13 15:56:58 -07:00
spec-main test: add test for invalid cookie url (#18751) 2019-06-12 19:49:36 -07:00
tools refactor: bundle the browser and renderer process electron code (#18553) 2019-06-02 13:03:03 -07:00
typings refactor: simplify content script injection (#18532) 2019-06-04 16:07:34 -07:00
vendor chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.clang-format
.dockerignore ci: migrate libcc's Dockerfile to electron and update it (#14786) 2018-09-25 15:30:22 -04:00
.env.example build: move Windows release builds to AppVeyor cloud (#18337) 2019-05-23 16:54:34 -04:00
.eslintrc.json build: ensure consistent lock files across multiple machines (#17955) 2019-04-30 13:59:47 -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: ensure consistent lock files across multiple machines (#17955) 2019-04-30 13:59:47 -07:00
.gitmodules chore: temporarily use submodule and gn DEPS for requests/boto 2018-10-06 22:07:10 +13:00
.remarkrc
appveyor.yml fix: use crashpad on Windows (#18483) 2019-06-13 15:42:21 +09:00
BUILD.gn fix: use crashpad on Windows (#18483) 2019-06-13 15:42:21 +09:00
CODE_OF_CONDUCT.md Change Contact Emails (#12278) 2018-03-15 04:37:40 +09:00
CONTRIBUTING.md add docs/development/README.md (#12373) 2018-03-20 15:36:48 -04:00
DEPS fix: use crashpad on Windows (#18483) 2019-06-13 15:42:21 +09:00
Dockerfile build: install python-dbusmock via pip for a Docker container (#18589) 2019-06-03 14:36:58 -04:00
Dockerfile.arm32v7 ci: use ubuntu 18.04 for arm testing (#14988) 2018-10-05 09:29:32 -05:00
Dockerfile.arm64v8 ci: Trigger an arm test on VSTS after CircleCI build (#14898) 2018-10-04 12:01:16 -04:00
electron_paks.gni chore: bump chromium to 2a7aff41ce73adc0eeee67d364989 (master) (#18505) 2019-06-03 20:44:12 -07:00
electron_resources.grd chore: use c++ manifests instead of json 2019-02-14 23:59:26 +05:30
electron_strings.grdp chore: bump chromium to 2a7aff41ce73adc0eeee67d364989 (master) (#18505) 2019-06-03 20:44:12 -07:00
ELECTRON_VERSION Bump v7.0.0-nightly.20190613 2019-06-13 08:32:58 -07:00
filenames.auto.gni chore: convert extension apis to TypeScript (#18688) 2019-06-14 07:52:24 -07:00
filenames.gni fix: use crashpad on Windows (#18483) 2019-06-13 15:42:21 +09:00
LICENSE fix: update license year (#16287) 2019-01-05 12:53:20 -08:00
package.json chore: upgrade docs-parser to fix nondeterminism (#18750) 2019-06-13 13:45:08 -07:00
README.md docs: add information about contributing (#17961) 2019-04-26 08:12:21 -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 build: Update TypeScript, use @typescript-eslint (#17251) 2019-03-07 12:56:02 -08: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 build: remove native mksnapshot for arm/arm64 (#17561) 2019-03-28 11:05:43 -04:00
vsts-arm32v7.yml ci: use ubuntu 18.04 for arm testing (#14988) 2018-10-05 09:29:32 -05:00
vsts-arm64v8.yml build: make torque patch more specific for native arm builds (#16992) 2019-02-18 10:02:50 +00:00
yarn.lock chore: upgrade docs-parser to fix nondeterminism (#18750) 2019-06-13 13:45:08 -07:00

Electron Logo

CircleCI Build Status AppVeyor Build Status Azure Pipelines 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 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.