No description
Find a file
Samuel Attard 48f2807473
docs: fix app.getPath types so that "name" is a string enum (#19480)
* docs: fix app.getPath types so that "name" is a string enum

Fixes https://github.com/electron/typescript-definitions/issues/140

* Update app.md
2019-07-26 16:11:22 -07:00
.circleci revert: use circleci v2.1 (#19456) 2019-07-25 10:44:28 -07:00
.github docs: mention fiddle in bug report template (#19248) 2019-07-15 22:16:02 -07:00
build chore: bump chromium to 79eae5b7b2d9dac441ac0182ee160 (master) (#19166) 2019-07-24 15:58:51 -07:00
buildflags feat: preliminary support for //extensions (#17440) 2019-07-24 16:01:08 -07:00
chromium_src chore: bump chromium to 79eae5b7b2d9dac441ac0182ee160 (master) (#19166) 2019-07-24 15:58:51 -07:00
components/pepper_flash chore: fix linking errors on Windows 2019-02-14 23:59:26 +05:30
default_app fix: app.getAppPath() returning default-app path for files or directories without package.json (#18763) 2019-06-19 23:34:22 +02:00
docs docs: fix app.getPath types so that "name" is a string enum (#19480) 2019-07-26 16:11:22 -07:00
docs-translations
lib feat: allow setting capture mode and max file size in netLog API (#19215) 2019-07-25 16:06:39 -07:00
native_mate chore: pass base::StringPiece args by value (#19432) 2019-07-25 10:19:04 -05:00
npm build: ensure that we bundle the correct version of @types/node (#19102) 2019-07-03 16:36:59 -07:00
patches chore: bump chromium to 2bbf84f6437b49c70922b65b38bf3 (master) (#19451) 2019-07-26 12:18:32 -07:00
script chore: remove no longer needed macOS SDK forward declarations (#19446) 2019-07-26 14:11:37 +02:00
shell fix: correctly emit BrowserWindow alwaysOnTop status in change event (#19463) 2019-07-26 15:53:31 -07:00
spec test: move autoUpdater specs to main process (#19440) 2019-07-26 10:52:57 -07:00
spec-main docs: fix app.getPath types so that "name" is a string enum (#19480) 2019-07-26 16:11:22 -07:00
tools chore: update to Node.js v12.4.0 (#18924) 2019-07-15 18:58:39 -07:00
typings feat: preliminary support for //extensions (#17440) 2019-07-24 16:01:08 -07:00
vendor
.clang-format
.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 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
.remarkrc
appveyor.yml ci: report test results to appveyor (#19434) 2019-07-25 11:30:56 -07:00
BUILD.gn feat: preliminary support for //extensions (#17440) 2019-07-24 16:01:08 -07:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Update CONTRIBUTING.md 2019-06-19 15:52:11 -07:00
DEPS chore: bump chromium to 2bbf84f6437b49c70922b65b38bf3 (master) (#19451) 2019-07-26 12:18:32 -07:00
Dockerfile chore: bump chromium to f1d9522c04ca8fa0a906f88ababe9 (master) (#18648) 2019-07-02 18:22:09 -07:00
Dockerfile.arm32v7 ci: use ubuntu 18.04 for arm testing (#14988) 2018-10-05 09:29:32 -05:00
Dockerfile.arm64v8 test: run all tests on arm linux platforms (#19318) 2019-07-19 16:15:47 -07: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.20190726 2019-07-26 08:31:42 -07:00
filenames.auto.gni feat: add memory to app.getAppMetrics() (#18831) 2019-07-23 13:41:58 -07:00
filenames.gni chore: remove no longer needed macOS SDK forward declarations (#19446) 2019-07-26 14:11:37 +02:00
LICENSE fix: update license year (#16287) 2019-01-05 12:53:20 -08:00
package.json Bump v7.0.0-nightly.20190726 2019-07-26 08:31:42 -07:00
README.md docs: update badges (#18955) 2019-06-24 14:09:17 -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 test: run all tests on arm linux platforms (#19318) 2019-07-19 16:15:47 -07:00
vsts-arm32v7.yml chore: bump chromium to f1d9522c04ca8fa0a906f88ababe9 (master) (#18648) 2019-07-02 18:22:09 -07:00
vsts-arm64v8.yml test: run all tests on arm linux platforms (#19318) 2019-07-19 16:15:47 -07:00
yarn.lock build: convert nodejs tap output to junit and store in circleci as test results 2019-07-24 14:43:49 -07: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.