No description
Find a file
aydon 9fcdb06272
Update quick-start.md (#29333)
In version 13.0.1 preload process should added to webPreferences.
2021-05-27 11:46:32 -07:00
.circleci build: ensure that mksnapshot for Apple Silicon has all of the needed files for snapshot generation (#29338) 2021-05-26 12:08:32 -04:00
.github chore: add wg-security as required reviewer for other files with IPC handlers (#29092) 2021-05-12 12:04:06 -07:00
.husky chore: Update husky v6.0.0 (#28827) 2021-04-29 09:46:15 +02:00
build feat: add experimental cookie encryption support (#27524) 2021-05-26 12:16:55 -07:00
buildflags chore: remove deprecated remote module (#25734) 2021-03-09 17:12:40 -08:00
chromium_src chore: bump chromium to 92.0.4511.0 (master) (#29173) 2021-05-19 16:15:47 -07:00
default_app fix: only set backgroundColor in default-app for default index.html (#28792) 2021-04-26 16:29:14 +09:00
docs Update quick-start.md (#29333) 2021-05-27 11:46:32 -07:00
lib refactor: expose process.contextId directly (#29236) 2021-05-24 16:51:54 +09:00
npm feat: allow path override with --ignore-scripts (#25377) 2020-12-03 16:23:44 +09:00
patches feat: add experimental cookie encryption support (#27524) 2021-05-26 12:16:55 -07:00
script build: only upload libcxx headers on linux 2021-05-23 17:11:21 -07:00
shell Bump v15.0.0-nightly.20210527 2021-05-27 11:06:31 -07:00
spec fix: webFrame spell checker APIs crashing in sandboxed renderers (#29053) 2021-05-10 14:19:23 +02:00
spec-main feat: add support for Blob's going over the ctx bridge (#29247) 2021-05-26 10:34:29 -07:00
typings fix: adjust initial webContents focus calculation (#29204) 2021-05-19 02:27:35 -07:00
.clang-format Add clang-format config file. 2016-10-04 22:42:49 +02:00
.dockerignore build: remove unused install-build-deps (#26891) 2020-12-09 09:26:21 -08:00
.env.example build: do not require vsts token for releases (#28643) 2021-04-13 15:30:46 -07:00
.eslintrc.json feat: add webContents.setWindowOpenHandler API (#24517) 2020-11-10 09:06:03 -08:00
.gitattributes chore: force source code and markdown files to use LF line ending (#25134) 2020-08-27 10:25:39 +09:00
.gitignore build: remove the vendor directory (#28883) 2021-04-28 00:38:08 -07:00
.markdownlint.autofix.json chore: use markdownlint to lint the docs (#26792) 2021-01-14 17:31:26 +09:00
.markdownlint.json chore: use markdownlint to lint the docs (#26792) 2021-01-14 17:31:26 +09:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
appveyor.yml build: enable woa testing (#28952) 2021-05-03 09:53:51 -04:00
azure-pipelines-arm.yml ci: enable arm64 macOS tests (#24832) 2021-01-21 18:36:52 -05:00
azure-pipelines-woa.yml ci: ignore errors deleting user app directories on WOA testing (#27709) 2021-02-15 09:44:32 +09:00
BUILD.gn feat: add experimental cookie encryption support (#27524) 2021-05-26 12:16:55 -07:00
CODE_OF_CONDUCT.md docs: use asterisks for unordered lists (#26552) 2020-11-23 12:15:27 -05:00
CONTRIBUTING.md chore: tidy up markdown (#26554) 2020-11-18 20:58:47 -08:00
DEPS chore: bump chromium to 92.0.4511.0 (master) (#29173) 2021-05-19 16:15:47 -07:00
electron_paks.gni chore: media_internal_resources becomes resources 2021-03-04 15:53:46 -08:00
electron_resources.grd feat: enable pdf viewer (#21794) 2020-02-12 16:39:12 -08:00
electron_strings.grdp chore: bump chromium to 92.0.4475.0 (master) (#28462) 2021-04-15 10:44:35 -07:00
ELECTRON_VERSION Bump v15.0.0-nightly.20210527 2021-05-27 11:06:31 -07:00
filenames.auto.gni refactor: implement <webview> using contextBridge (#29037) 2021-05-15 16:42:07 +09:00
filenames.gni fix: load source maps from custom protocols and asar bundles (#28573) 2021-04-11 21:59:36 -07:00
filenames.hunspell.gni chore: bump chromium to 6d130075d378a64187360ba4e7820 (master) (#24256) 2020-07-13 21:13:34 -04:00
filenames.libcxx.gni test: rebuild nan tests with libc++ and libc++abi (#29281) 2021-05-22 11:48:38 -07:00
filenames.libcxxabi.gni test: rebuild nan tests with libc++ and libc++abi (#29281) 2021-05-22 11:48:38 -07:00
LICENSE chore: update copyright headers (#27697) 2021-02-12 15:22:41 -08:00
package.json Bump v15.0.0-nightly.20210527 2021-05-27 11:06:31 -07:00
README.md docs: update "list" of docs languages in readme.md file (#29073) 2021-05-13 11:12:35 +09:00
SECURITY.md chore: tidy up markdown (#26554) 2020-11-18 20:58:47 -08:00
tsconfig.default_app.json
tsconfig.electron.json
tsconfig.json chore: update to latest TypeScript, which has built-in WeakRef declarations (#27425) 2021-01-22 11:25:47 -08:00
tsconfig.script.json build: auto-push patch file changes (#26235) 2020-10-29 14:21:23 -04:00
tsconfig.spec.json
vsts-arm-test-steps.yml chore: bump chromium to 92.0.4475.0 (master) (#28462) 2021-04-15 10:44:35 -07:00
vsts-arm32v7.yml build: update docker images to node 14 (#27915) 2021-03-01 20:45:20 +09:00
vsts-arm64v8.yml build: update docker images to node 14 (#27915) 2021-03-01 20:45:20 +09:00
yarn.lock build(deps): bump lodash from 4.17.20 to 4.17.21 (#29066) 2021-05-11 14:02:14 -07:00

Electron Logo

CircleCI Build Status AppVeyor Build Status devDependency Status Electron Discord Invite

📝 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

For more installation options and troubleshooting tips, see installation. For info on how to manage Electron versions in your apps, see Electron versioning.

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.