Haxe type definitions for the electron framework
Clone or download
Latest commit e0fa520 Sep 21, 2018

README.md

HXElectron

Haxe type definitions for electron, a framework for building cross-platform desktop applications with JavaScript, HTML, and CSS.

Build Status Haxelib Version

Install

# Release version from haxelib
haxelib install electron

# Development version from git
haxelib git electron https://github.com/tong/hxelectron.git

Generate Type Definitions

All type definitions are generated from electron-api.json by ElectronAPI.hx.

To (re)generate for another electron version download the description file from https://github.com/electron/electron/releases and run:

## Generate type definitions
haxe --macro ElectronAPI.generate("optional/path/to/electron-api.json")

## Build haxedoc.xml to insure everything is fine
haxe haxedoc.hxml

By default hxelectron/electron-api.json is used if you ommit the path argument to your custom description file.

Usage

Demo Application

Spin up the included demo application to see electron in action:

## Make sure you have Electron installed (you only need to do this once)
npm install -g electron@latest

## Clone this repository
git clone https://github.com/tong/hxelectron
cd hxelectron/

## Set the haxelib development directory
haxelib dev electron .

## Build and run the demo application
cd demo/
haxe build.hxml
electron bin/

Metadata

The haxe externs are attributed with following metadata:

  • @:electron_platforms(["Linux"|"macOS"|"Windows"]) the supporting platforms (only if specific).