Hello World!
5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /spec/fixtures/module/preload-sandboxæø åü.js: -------------------------------------------------------------------------------- 1 | (function () { 2 | window.require = require; 3 | if (location.protocol === 'file:') { 4 | window.test = 'preload'; 5 | } 6 | })(); 7 | -------------------------------------------------------------------------------- /spec/fixtures/pages/b.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
4 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/spec/fixtures/pages/ping.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/spec/fixtures/pages/save_page/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
--------------------------------------------------------------------------------
/spec/fixtures/api/localstorage.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/spec/fixtures/module/empty.js:
--------------------------------------------------------------------------------
1 | const { ipcRenderer } = require('electron');
2 |
3 | window.addEventListener('message', (event) => {
4 | ipcRenderer.send('leak-result', event.data);
5 | });
6 |
--------------------------------------------------------------------------------
/spec/fixtures/module/preload-ipc.js:
--------------------------------------------------------------------------------
1 | const { ipcRenderer } = require('electron');
2 | ipcRenderer.on('ping', function (event, message) {
3 | ipcRenderer.sendToHost('pong', message);
4 | });
5 |
--------------------------------------------------------------------------------
/spec/fixtures/module/print-crash-parameters.js:
--------------------------------------------------------------------------------
1 | process.crashReporter.addExtraParameter('hello', 'world');
2 | process.stdout.write(JSON.stringify(process.crashReporter.getParameters()) + '\n');
3 |
--------------------------------------------------------------------------------
/.env.example:
--------------------------------------------------------------------------------
1 | # These env vars are only necessary for creating Electron releases.
2 | # See docs/development/releasing.md
3 |
4 | APPVEYOR_CLOUD_TOKEN=
5 | CIRCLE_TOKEN=
6 | ELECTRON_GITHUB_TOKEN=
7 |
--------------------------------------------------------------------------------
/docs/api/structures/protocol-response-upload-data.md:
--------------------------------------------------------------------------------
1 | # ProtocolResponseUploadData Object
2 |
3 | * `contentType` string - MIME type of the content.
4 | * `data` string | Buffer - Content to be sent.
5 |
--------------------------------------------------------------------------------
/docs/fiddles/ipc/webview-new-window/renderer.js:
--------------------------------------------------------------------------------
1 | const webview = document.getElementById('webview')
2 | webview.addEventListener('new-window', () => {
3 | console.log('got new-window event')
4 | })
5 |
--------------------------------------------------------------------------------
/lib/browser/ipc-main-internal.ts:
--------------------------------------------------------------------------------
1 | import { IpcMainImpl } from '@electron/internal/browser/ipc-main-impl';
2 |
3 | export const ipcMainInternal = new IpcMainImpl() as ElectronInternal.IpcMainInternal;
4 |
--------------------------------------------------------------------------------
/spec/fixtures/extensions/chrome-action-fail/popup.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/spec/fixtures/extensions/load-error/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "load-error",
3 | "version": "1.0",
4 | "icons": {
5 | "16": "/images/error.png"
6 | },
7 | "manifest_version": 2
8 | }
9 |
--------------------------------------------------------------------------------
/spec/fixtures/module/send-later.js:
--------------------------------------------------------------------------------
1 | const { ipcRenderer } = require('electron');
2 | window.onload = function () {
3 | ipcRenderer.send('answer', typeof window.process, typeof window.Buffer);
4 | };
5 |
--------------------------------------------------------------------------------
/spec/fixtures/pages/webview-stripped-preload.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/tsconfig.electron.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "./tsconfig.json",
3 | "compilerOptions": {
4 | "rootDir": "lib"
5 | },
6 | "include": [
7 | "lib",
8 | "typings"
9 | ]
10 | }
11 |
--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 |
3 | github: ['Alex313031']
4 | custom: ['https://paypal.me/alex313031?country.x=US&locale.x=en_US']
5 | patreon: ThoriumDeveloper
6 |
--------------------------------------------------------------------------------
/docs/api/structures/scrubber-item.md:
--------------------------------------------------------------------------------
1 | # ScrubberItem Object
2 |
3 | * `label` string (optional) - The text to appear in this item.
4 | * `icon` NativeImage (optional) - The image to appear in this item.
5 |
--------------------------------------------------------------------------------
/spec/fixtures/extensions/devtools-extension/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | a custom devtools extension
4 |
5 |
6 |
--------------------------------------------------------------------------------
/spec/fixtures/module/echo.js:
--------------------------------------------------------------------------------
1 | process.on('uncaughtException', function (err) {
2 | process.send(err.message);
3 | });
4 |
5 | const echo = require('@electron-ci/echo');
6 | process.send(echo('ok'));
7 |
--------------------------------------------------------------------------------
/spec/fixtures/native-addon/echo/binding.gyp:
--------------------------------------------------------------------------------
1 | {
2 | "targets": [
3 | {
4 | "target_name": "echo",
5 | "sources": [
6 | "binding.cc"
7 | ]
8 | }
9 | ]
10 | }
11 |
--------------------------------------------------------------------------------
/spec/fixtures/pages/e.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/spec/is-valid-window/src/impl_posix.cc:
--------------------------------------------------------------------------------
1 | #include "impl.h"
2 |
3 | namespace impl {
4 |
5 | bool IsValidWindow(char* handle, size_t size) {
6 | return true;
7 | }
8 |
9 | } // namespace impl
10 |
--------------------------------------------------------------------------------
/spec/fixtures/pages/partition/one.html:
--------------------------------------------------------------------------------
1 |
7 |
--------------------------------------------------------------------------------
/spec/fixtures/pages/window-opener-postMessage.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/.git-blame-ignore-revs:
--------------------------------------------------------------------------------
1 | # Atom --> Electron rename
2 | d9321f4df751fa32813fab1b6387bbd61bd681d0
3 | 34c4c8d5088fa183f56baea28809de6f2a427e02
4 | # Enable JS Semicolons
5 | 5d657dece4102e5e5304d42e8004b6ad64c0fcda
6 |
--------------------------------------------------------------------------------
/docs/api/structures/file-path-with-headers.md:
--------------------------------------------------------------------------------
1 | # FilePathWithHeaders Object
2 |
3 | * `path` string - The path to the file to send.
4 | * `headers` RecordHello World!
Close this Window' 5 | window.electronAPI.createFramelessWindow({ url }) 6 | }) 7 | -------------------------------------------------------------------------------- /spec/fixtures/api/quit-app/main.js: -------------------------------------------------------------------------------- 1 | const { app } = require('electron'); 2 | 3 | app.whenReady().then(function () { 4 | // This setImmediate call gets the spec passing on Linux 5 | setImmediate(function () { 6 | app.exit(123); 7 | }); 8 | }); 9 | 10 | process.on('exit', function (code) { 11 | console.log('Exit event with code: ' + code); 12 | }); 13 | -------------------------------------------------------------------------------- /spec/fixtures/extensions/chrome-storage/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "chrome-storage", 3 | "version": "1.0", 4 | "content_scripts": [ 5 | { 6 | "matches": ["Hello World!
10 |Right click the dock icon to see the custom menu options.
11 | 12 | 13 | -------------------------------------------------------------------------------- /npm/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "index.js", 3 | "types": "electron.d.ts", 4 | "bin": { 5 | "electron": "cli.js" 6 | }, 7 | "scripts": { 8 | "postinstall": "node install.js" 9 | }, 10 | "dependencies": { 11 | "@electron/get": "^2.0.0", 12 | "@types/node": "^18.11.18", 13 | "extract-zip": "^2.0.1" 14 | }, 15 | "engines": { 16 | "node": ">= 12.20.55" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /spec/fixtures/apps/open-new-window-from-link/new-window-page.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |Connection status:
10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /lib/browser/api/exports/electron.ts: -------------------------------------------------------------------------------- 1 | import { defineProperties } from '@electron/internal/common/define-properties'; 2 | import { commonModuleList } from '@electron/internal/common/api/module-list'; 3 | import { browserModuleList } from '@electron/internal/browser/api/module-list'; 4 | 5 | module.exports = {}; 6 | 7 | defineProperties(module.exports, commonModuleList); 8 | defineProperties(module.exports, browserModuleList); 9 | -------------------------------------------------------------------------------- /spec/fixtures/extensions/chrome-tabs/api-async/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "api-async", 3 | "version": "1.0", 4 | "content_scripts": [ 5 | { 6 | "matches": [ "Hello World!
10 |After launching this application, you should see the system notification.
11 | 12 | 13 | -------------------------------------------------------------------------------- /lib/renderer/api/exports/electron.ts: -------------------------------------------------------------------------------- 1 | import { defineProperties } from '@electron/internal/common/define-properties'; 2 | import { commonModuleList } from '@electron/internal/common/api/module-list'; 3 | import { rendererModuleList } from '@electron/internal/renderer/api/module-list'; 4 | 5 | module.exports = {}; 6 | 7 | defineProperties(module.exports, commonModuleList); 8 | defineProperties(module.exports, rendererModuleList); 9 | -------------------------------------------------------------------------------- /spec/fixtures/api/native-window-open-file.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /spec/fixtures/api/utility-process/inherit-stderr/main.js: -------------------------------------------------------------------------------- 1 | const { app, utilityProcess } = require('electron'); 2 | const path = require('node:path'); 3 | 4 | app.whenReady().then(() => { 5 | const payload = app.commandLine.getSwitchValue('payload'); 6 | const child = utilityProcess.fork(path.join(__dirname, 'test.js'), [`--payload=${payload}`]); 7 | child.on('exit', () => { 8 | app.quit(); 9 | }); 10 | }); 11 | -------------------------------------------------------------------------------- /spec/fixtures/api/utility-process/inherit-stdout/main.js: -------------------------------------------------------------------------------- 1 | const { app, utilityProcess } = require('electron'); 2 | const path = require('node:path'); 3 | 4 | app.whenReady().then(() => { 5 | const payload = app.commandLine.getSwitchValue('payload'); 6 | const child = utilityProcess.fork(path.join(__dirname, 'test.js'), [`--payload=${payload}`]); 7 | child.on('exit', () => { 8 | app.quit(); 9 | }); 10 | }); 11 | -------------------------------------------------------------------------------- /spec/fixtures/auto-update/initial/index.js: -------------------------------------------------------------------------------- 1 | process.on('uncaughtException', (err) => { 2 | console.error(err); 3 | process.exit(1); 4 | }); 5 | 6 | const { autoUpdater } = require('electron'); 7 | 8 | const feedUrl = process.argv[1]; 9 | 10 | console.log('Setting Feed URL'); 11 | 12 | autoUpdater.setFeedURL({ 13 | url: feedUrl 14 | }); 15 | 16 | console.log('Feed URL Set:', feedUrl); 17 | 18 | process.exit(0); 19 | -------------------------------------------------------------------------------- /spec/fixtures/extensions/host-permissions/privileged-tab-info/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "privileged-tab-info", 3 | "version": "0.1", 4 | "manifest_version": 3, 5 | "content_scripts": [{ 6 | "matches": [ "Hello World!
10 |Hit Ctrl+I to see a message printed to the console.
11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/renderer.js: -------------------------------------------------------------------------------- 1 | // This file is required by the index.html file and will 2 | // be executed in the renderer process for that window. 3 | // All APIs exposed by the context bridge are available here. 4 | 5 | // Binds the buttons to the context bridge API. 6 | document.getElementById('open-in-browser').addEventListener('click', () => { 7 | window.shell.open() 8 | }) 9 | -------------------------------------------------------------------------------- /shell/app/node_main.h: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2015 GitHub, Inc. 2 | // Use of this source code is governed by the MIT license that can be 3 | // found in the LICENSE file. 4 | 5 | #ifndef ELECTRON_SHELL_APP_NODE_MAIN_H_ 6 | #define ELECTRON_SHELL_APP_NODE_MAIN_H_ 7 | 8 | namespace electron { 9 | 10 | int NodeMain(int argc, char* argv[]); 11 | 12 | } // namespace electron 13 | 14 | #endif // ELECTRON_SHELL_APP_NODE_MAIN_H_ 15 | -------------------------------------------------------------------------------- /spec/fixtures/crash-cases/fs-promises-renderer-crash/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /spec/fixtures/crash-cases/transparent-window-get-background-color/index.js: -------------------------------------------------------------------------------- 1 | const { app, BrowserWindow } = require('electron'); 2 | 3 | function createWindow () { 4 | // Create the browser window. 5 | const mainWindow = new BrowserWindow({ 6 | transparent: true 7 | }); 8 | mainWindow.getBackgroundColor(); 9 | } 10 | 11 | app.on('ready', () => { 12 | createWindow(); 13 | setTimeout(() => app.quit()); 14 | }); 15 | -------------------------------------------------------------------------------- /spec/fixtures/pages/webview-devtools.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 |
3 | WebView
4 |
5 |
6 |
13 |
14 |
--------------------------------------------------------------------------------
/docs/api/structures/hid-device.md:
--------------------------------------------------------------------------------
1 | # HIDDevice Object
2 |
3 | * `deviceId` string - Unique identifier for the device.
4 | * `name` string - Name of the device.
5 | * `vendorId` Integer - The USB vendor ID.
6 | * `productId` Integer - The USB product ID.
7 | * `serialNumber` string (optional) - The USB device serial number.
8 | * `guid` string (optional) - Unique identifier for the HID interface. A device may have multiple HID interfaces.
9 |
--------------------------------------------------------------------------------
/docs/fiddles/native-ui/external-links-file-manager/renderer.js:
--------------------------------------------------------------------------------
1 | const exLinksBtn = document.getElementById('open-ex-links')
2 | const fileManagerBtn = document.getElementById('open-file-manager')
3 |
4 | fileManagerBtn.addEventListener('click', (event) => {
5 | window.electronAPI.openHomeDir()
6 | })
7 |
8 | exLinksBtn.addEventListener('click', (event) => {
9 | window.electronAPI.openExternal('https://electronjs.org')
10 | })
11 |
--------------------------------------------------------------------------------
/script/generate-zip-manifest.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import zipfile
4 | import sys
5 |
6 | def main(zip_path, manifest_out):
7 | with open(manifest_out, 'w') as manifest, \
8 | zipfile.ZipFile(zip_path, 'r', allowZip64=True) as z:
9 | for name in sorted(z.namelist()):
10 | manifest.write(name + '\n')
11 | return 0
12 |
13 | if __name__ == '__main__':
14 | sys.exit(main(sys.argv[1], sys.argv[2]))
15 |
--------------------------------------------------------------------------------
/script/lib/npm.py:
--------------------------------------------------------------------------------
1 | import subprocess
2 | import sys
3 |
4 |
5 | def npm(*npm_args):
6 | call_args = [__get_executable_name()] + list(npm_args)
7 | subprocess.check_call(call_args)
8 |
9 |
10 | def __get_executable_name():
11 | executable = 'npm'
12 | if sys.platform == 'win32':
13 | executable += '.cmd'
14 | return executable
15 |
16 |
17 | if __name__ == '__main__':
18 | npm(*sys.argv[1:])
19 |
--------------------------------------------------------------------------------
/spec/fixtures/api/first-party-sets/command-line/main.js:
--------------------------------------------------------------------------------
1 | const { app } = require('electron');
2 |
3 | app.whenReady().then(function () {
4 | const hasSwitch = app.commandLine.hasSwitch('use-first-party-set');
5 | const value = app.commandLine.getSwitchValue('use-first-party-set');
6 | if (hasSwitch) {
7 | process.stdout.write(JSON.stringify(value));
8 | process.stdout.end();
9 | }
10 |
11 | app.quit();
12 | });
13 |
--------------------------------------------------------------------------------
/spec/fixtures/apps/crash/sandbox-preload.js:
--------------------------------------------------------------------------------
1 | const { crashReporter } = require('electron');
2 |
3 | const params = new URLSearchParams(location.search);
4 | if (params.get('set_extra') === '1') {
5 | crashReporter.addExtraParameter('rendererSpecific', 'rs');
6 | crashReporter.addExtraParameter('addedThenRemoved', 'to-be-removed');
7 | crashReporter.removeExtraParameter('addedThenRemoved');
8 | }
9 |
10 | process.crash();
11 |
--------------------------------------------------------------------------------
/spec/fixtures/extensions/lazy-background-page/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "lazy-background-page",
3 | "version": "1.0",
4 | "background": {
5 | "scripts": ["background.js"],
6 | "persistent": false
7 | },
8 | "content_scripts": [
9 | {
10 | "matches": ["Hello World!
10 |Hit Alt+Ctrl+I on Windows or Opt+Cmd+I on Mac to see a message printed to the console.
11 | 12 | 13 | -------------------------------------------------------------------------------- /script/codesign/codesign.cnf: -------------------------------------------------------------------------------- 1 | [req] 2 | default_bits = 4096 3 | encrypt_key = no 4 | default_md = sha512 5 | distinguished_name = req_distinguished_name 6 | prompt = no 7 | 8 | [req_distinguished_name] 9 | C = CA 10 | ST = BC 11 | L = Vancouver 12 | O = ElectronJS 13 | OU = BuildAutomation 14 | CN = codesign.electronjs.org 15 | 16 | [extended] 17 | keyUsage = critical,digitalSignature 18 | extendedKeyUsage = critical,codeSigning 19 | -------------------------------------------------------------------------------- /docs/fiddles/features/keyboard-shortcuts/local/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 |Hello World!
10 |Hit Alt+Shift+I on Windows, or Opt+Cmd+I on mac to see a message printed to the console.
11 | 12 | 13 | -------------------------------------------------------------------------------- /spec/.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "mocha": true, 5 | "serviceworker": true 6 | }, 7 | "globals": { 8 | "Bindings": true, 9 | "Components": true, 10 | "UI": true, 11 | "WebView": true 12 | }, 13 | "plugins": [ 14 | "mocha", 15 | "unicorn" 16 | ], 17 | "rules": { 18 | "mocha/no-exclusive-tests": "error", 19 | "unicorn/prefer-node-protocol": "error" 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /spec/fixtures/api/native-window-open-blank.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /spec/fixtures/pages/fetch.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/api/structures/ipc-main-invoke-event.md: -------------------------------------------------------------------------------- 1 | # IpcMainInvokeEvent Object extends `Event` 2 | 3 | * `processId` Integer - The internal ID of the renderer process that sent this message 4 | * `frameId` Integer - The ID of the renderer frame that sent this message 5 | * `sender` [WebContents](../web-contents.md) - Returns the `webContents` that sent the message 6 | * `senderFrame` [WebFrameMain](../web-frame-main.md) _Readonly_ - The frame that sent this message 7 | -------------------------------------------------------------------------------- /lib/browser/api/system-preferences.ts: -------------------------------------------------------------------------------- 1 | const { systemPreferences } = process._linkedBinding('electron_browser_system_preferences'); 2 | 3 | if ('getEffectiveAppearance' in systemPreferences) { 4 | const nativeEAGetter = systemPreferences.getEffectiveAppearance; 5 | Object.defineProperty(systemPreferences, 'effectiveAppearance', { 6 | get: () => nativeEAGetter.call(systemPreferences) 7 | }); 8 | } 9 | 10 | export default systemPreferences; 11 | -------------------------------------------------------------------------------- /shell/browser/native_window_features.cc: -------------------------------------------------------------------------------- 1 | // Copyright (c) 2022 Slack Technologies, Inc. 2 | // Use of this source code is governed by the MIT license that can be 3 | // found in the LICENSE file. 4 | 5 | #include "shell/browser/native_window_features.h" 6 | 7 | namespace features { 8 | const base::Feature kWaylandWindowDecorations{"WaylandWindowDecorations", 9 | base::FEATURE_ENABLED_BY_DEFAULT}; 10 | } 11 | -------------------------------------------------------------------------------- /spec/fixtures/extensions/chrome-scripting/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "execute-script", 3 | "version": "1.0", 4 | "permissions": [ 5 | "scripting" 6 | ], 7 | "host_permissions": ["