Info on reporting bugs, getting help, finding third-party tools and sample apps,Īnd more can be found on the Community page.
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. We currently accept translations for Chinese (Simplified), French, German, Japanese, Portuguese, We crowdsource translations for our documentation via Crowdin. See the Advanced Installation Instructions to learn how to use a custom mirror. spawn Electron const child = proc.spawn(electron) will print something similar to /Users/maf/./Electron console.log(electron) Use this to spawn Electron from Node scripts: const electron = require( 'electron') Your Node app (not your Electron app) it will return the file path to theīinary. Most people use Electron from the command line, but if you require electron inside /community#boilerplates - Sample starter apps created by the community.electron/electron-quick-start - A very basic starter Electron app.electron/fiddle - A tool to build, run, and package small Electron experiments./docs - All of Electron's documentation.Repository to see a minimal Electron app in action: git clone
It's designed to make the start of your journey with To try out different versions of Electron. Electronic seals may provide strong legal evidence that the document has not been altered and originated from the entity identified by the digital sealing certificate. To build, run, and package small Electron experiments, to see code examples for all of Electron's APIs, and An electronic seal or e-seal is used by a legal entity such as a business or organization to certify the origin, authenticity, and integrity of documents. Linux: The prebuilt binaries of Electron are built on Ubuntu 20.04.
Windows on ARM support was added in Electron 5.0.8.
The preferred method is to install Electron as a development dependency in yourįor more installation options and troubleshooting tips, see To install prebuilt Electron binaries, use npm.
This project adheres to the Contributor Covenantīy participating, you are expected to uphold this code. The Electron framework lets you write cross-platform desktop applications View these docs in other languages on our Crowdin project. This means that for your API type definition to appear in the electron.d.ts file, we must create a. This step is necessary to ensure consistency across Electron's API documentation. The haxe externs are attributed with following metadata: Electron API specs, API docs, OpenAPI support, SDKs, GraphQL, developer docs, CLI, IDE plugins, API pricing, developer experience, authentication, and API styles. Create API documentation Type definitions are generated by Electron using electron/docs-parser and electron/typescript-definitions. To get the latest version of Electrons structured docs, see the electron-api.json artifact in any Electron releaase. Spin up the included demo application to see electron in action: # Clone this repository # Build haxedoc.xml to insure everything is fineīy default hxelectron/electron-api.json is used if you ommit the path argument to your custom description file. Haxe -macro ElectronAPI.generate("optional/path/to/electron-api.json") Type definitions are generated by Electron using electron/docs-parser and electron/typescript-definitions.
To (re)generate for another electron version download the description file from and run: # Generate type definitions Haxelib git electron Generate Type DefinitionsĪll type definitions are generated from electron-api.json by ElectronAPI.hx. Haxe type definitions for electron, a framework for building cross-platform desktop applications with JavaScript, HTML, and CSS.