No description
Find a file
Raymond Zhao 5fc3ed936e
feat: add app.getPreferredSystemLanguages() API (#36035)
* feat: add app.getSystemLanguage() API

* Change the API to getPreferredSystemLanguages

* Fix test

* Clarify docs and add Linux impl

* Remove USE_GLIB

* Don't add C to list

* Remove examples since there's a lot of edge cases

* Fix lint

* Add examples

* Fix compile error

* Apply PR feedback

* Update the example
2022-11-09 10:50:43 -05:00
.circleci build: determine electron version from tags not files (#36106) 2022-10-24 23:44:43 -07:00
.devcontainer build: fix gclient config file 2021-08-16 10:56:29 -07:00
.github build: move from stale GH app to stale action (#35845) 2022-10-03 23:36:01 -07:00
.husky chore: update husky to v8.0.1 (#34343) 2022-06-01 13:00:48 -04:00
build chore: bump chromium to 109.0.5382.0 (main) (#36057) 2022-10-27 12:37:04 -04:00
buildflags feat: add immersive dark mode on windows (#33624) 2022-06-14 12:27:28 -04:00
chromium_src chore: bump chromium to 109.0.5382.0 (main) (#36057) 2022-10-27 12:37:04 -04:00
default_app fix: override app's desktop name and v8 flags in default-app (#35997) 2022-10-17 10:34:24 +02:00
docs feat: add app.getPreferredSystemLanguages() API (#36035) 2022-11-09 10:50:43 -05:00
lib fix: remove undocumented feature and flaky test for webview resize event (#36154) 2022-10-27 16:44:53 -07:00
npm fix: Handle an electron.d.ts file in a custom build (#33979) 2022-09-26 14:39:26 -04:00
patches chore: bump chromium to 109.0.5382.0 (main) (#36057) 2022-10-27 12:37:04 -04:00
script fix: arm linux glibc dependency (#36247) 2022-11-07 09:38:08 -05:00
shell feat: add app.getPreferredSystemLanguages() API (#36035) 2022-11-09 10:50:43 -05:00
spec feat: add app.getPreferredSystemLanguages() API (#36035) 2022-11-09 10:50:43 -05:00
spec-chromium chore: bump chromium to 109.0.5382.0 (main) (#36057) 2022-10-27 12:37:04 -04:00
typings feat: UtilityProcess API (#34980) 2022-10-19 22:49:49 -07:00
.clang-format
.dockerignore build: remove unused install-build-deps (#26891) 2020-12-09 09:26:21 -08:00
.env.example
.eslintrc.json chore: bump chromium to 102.0.4961.0 (main) (#33091) 2022-03-24 21:39:03 -04:00
.git-blame-ignore-revs chore: add ignore revs file for GH blame UI (#33171) 2022-03-07 18:40:28 -08:00
.gitattributes
.gitignore test: fix some broken globs for spec-main (#35439) 2022-08-25 09:36:08 -07:00
.markdownlint.autofix.json
.markdownlint.json docs: expand tutorial (#34604) 2022-06-22 17:17:48 +09:00
.nvmrc build: update .nvmrc Node.js version from 14 to 16 (#35676) 2022-09-15 15:40:18 -07:00
.remarkrc add remark lint to ensure fenced codeblocks are formatted properly. 2017-11-20 14:05:47 +08:00
appveyor.yml build: use python3 for appveyor commands (#36131) 2022-10-25 16:39:21 -07:00
BUILD.gn build: fix building with enable_plugins = false (#36193) 2022-10-31 16:18:15 -07:00
CODE_OF_CONDUCT.md docs: use asterisks for unordered lists (#26552) 2020-11-23 12:15:27 -05:00
CONTRIBUTING.md docs: Update Branch Name (#31106) 2021-09-27 11:35:56 -04:00
DEPS chore: bump chromium to 109.0.5382.0 (main) (#36057) 2022-10-27 12:37:04 -04:00
electron_paks.gni chore: bump chromium to 104.0.5073.0 (main) (#34272) 2022-06-01 08:12:47 +02:00
electron_resources.grd chore: use //chrome resources directly (#33626) 2022-04-06 09:34:35 -07:00
filenames.auto.gni feat: UtilityProcess API (#34980) 2022-10-19 22:49:49 -07:00
filenames.gni refactor: move draggable regions to WebContents (#36230) 2022-11-07 10:15:57 -08:00
filenames.hunspell.gni chore: bump chromium to 102.0.4961.0 (main) (#33091) 2022-03-24 21:39:03 -04:00
filenames.libcxx.gni chore: update libcxx filenames (#35904) 2022-10-04 15:29:24 -04:00
filenames.libcxxabi.gni chore: bump chromium to 102.0.4961.0 (main) (#33091) 2022-03-24 21:39:03 -04:00
LICENSE
package.json build: determine electron version from tags not files (#36106) 2022-10-24 23:44:43 -07:00
README.md docs: update supported Mac versions (#35911) 2022-10-04 21:25:03 -07:00
SECURITY.md docs: Update Branch Name (#31106) 2021-09-27 11:35:56 -04:00
tsconfig.default_app.json
tsconfig.electron.json
tsconfig.json
tsconfig.script.json
tsconfig.spec.json test: drop now-empty remote runner (#35343) 2022-08-16 15:23:13 -04:00
yarn.lock build(deps): bump loader-utils from 1.2.3 to 1.4.1 (#36276) 2022-11-08 11:27:59 +01:00

Electron Logo

CircleCI Build Status AppVeyor Build Status Electron Discord Invite

📝 Available Translations: 🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪. View these docs in other languages on our Crowdin project.

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.

Platform support

Each Electron release provides binaries for macOS, Windows, and Linux.

  • macOS (High Sierra and up): Electron provides 64-bit Intel and ARM binaries for macOS. Apple Silicon support was added in Electron 11.
  • Windows (Windows 7 and up): Electron provides ia32 (x86), x64 (amd64), and arm64 binaries for Windows. Windows on ARM support was added in Electron 5.0.8.
  • Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04. They have also been verified to work on:
    • Ubuntu 14.04 and newer
    • Fedora 24 and newer
    • Debian 8 and newer

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

See the Advanced Installation Instructions to learn how to use a custom mirror.

Documentation translations

We crowdsource translations for our documentation via Crowdin. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, Russian, and Spanish.

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 on the Community page.

License

MIT

When using Electron logos, make sure to follow OpenJS Foundation Trademark Policy.