You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2019/03/04 03:01:55 UTC
svn commit: r1854748 [2/3] - in /cordova/site/public: ./ contribute/
docs/en/6.x/reference/cordova-cli/
docs/en/6.x/reference/cordova-plugin-battery-status/
docs/en/6.x/reference/cordova-plugin-camera/
docs/en/6.x/reference/cordova-plugin-device/ docs/...
Added: cordova/site/public/docs/en/dev/guide/platforms/electron/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/electron/index.html?rev=1854748&view=auto
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/electron/index.html (added)
+++ cordova/site/public/docs/en/dev/guide/platforms/electron/index.html Mon Mar 4 03:01:54 2019
@@ -0,0 +1,3200 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="format-detection" content="telephone=no">
+ <meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width" />
+ <meta name="description" content=" ">
+
+ <title>
+
+
+ Electron Platform Guide - Apache Cordova
+
+
+ </title>
+
+ <link rel="SHORTCUT ICON" href="/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+ <link rel="canonical" href="https://cordova.apache.org/docs/en/dev/guide/platforms/electron/">
+
+ <!-- CSS -->
+ <link rel="stylesheet" type="text/css" href="/static/css/main.css">
+ <link rel="stylesheet" type="text/css" href="/static/css/lib/syntax.css">
+ <!-- Algolia Search CSS -->
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css" />
+
+ <!-- Fonts -->
+ <!-- For attribution information, see www/attributions.html -->
+ <link href='https://fonts.googleapis.com/css?family=Raleway:700,400,300,700italic,400italic,300italic' rel='stylesheet' type='text/css'>
+
+ <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+ <!--[if lt IE 9]>
+ <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+ <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+ <![endif]-->
+ <script type="text/javascript">
+ var disqus_developer = 1; // this would set it to developer mode
+ </script>
+
+ <!-- JS -->
+ <script defer type="text/javascript" src="/static/js/lib/jquery-2.1.1.min.js"></script>
+ <script defer type="text/javascript" src="/static/js/lib/bootstrap.min.js"></script>
+ <script defer type="text/javascript" src="/static/js/lib/ZeroClipboard.js"></script>
+
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+ ga('create', 'UA-64283057-3', 'auto');
+ ga('send', 'pageview');
+</script>
+
+</head>
+
+<body>
+ <header>
+ <a class="scroll-point pt-top" name="top"></a>
+ <nav class="navbar navbar-inverse navbar-fixed-top">
+ <div class="container-fluid">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="/"><img id="logo_top" src="/static/img/cordova-logo-newbrand.svg"/></a>
+ </div>
+ <div id="navbar" class="navbar-collapse collapse">
+ <div class="nav_bar_center">
+ <ul class="nav navbar-nav">
+ <li class="active">
+ <a href="/docs/en/latest/">Documentation</a>
+ </li>
+ <li >
+ <a href="/plugins">Plugins</a>
+ </li>
+ <li >
+ <a href="/blog" id="blog_button">Blog<span class="badge" id="new_blog_count"></span></a>
+ </li>
+ <li >
+ <a href="/contribute">Contribute</a>
+ </li>
+ <li>
+ <a href="/#getstarted">Get Started</a>
+ </li>
+ <li>
+ <form class="navbar-form navbar-right" id="header-search-form" role="search">
+ <div class="input-group">
+
+
+
+ <input id="header-search-field" type="text" placeholder="Search 'dev' docs..." class="form-control hidden-xs" autocomplete="off">
+ </div>
+ </form>
+ </li>
+ </ul>
+ </div>
+ </div><!--/.navbar-collapse -->
+ </div>
+ </nav>
+ <div id="_fixed_navbar_spacer" style="padding-top:50px"></div>
+</header>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div class="docs">
+
+ <!-- Table of Contents -->
+ <div class="hidden-xs hidden-sm site-toc-container">
+ <ul class="site-toc">
+
+
+ <li>
+
+ <span class="toc-section-heading">
+ Introduction
+ </span>
+
+
+
+
+
+
+ <ul class="site-toc">
+
+
+ <li>
+
+ <a class="" href="../../../guide/overview/index.html">
+ Overview
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+</ul>
+
+
+ </li>
+
+
+ <li>
+
+ <span class="toc-section-heading">
+ Create apps
+ </span>
+
+
+
+
+
+
+ <ul class="site-toc">
+
+
+ <li>
+
+ <a class="" href="../../../guide/cli/index.html">
+ Create your first app
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/cli/template.html">
+ Templates for apps
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/support/index.html">
+ Platform support
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <span class="toc-section-heading">
+ Develop for platforms
+ </span>
+
+
+
+
+
+
+ <ul class="site-toc">
+
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/android/index.html">
+ Android
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/ios/index.html">
+ iOS
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/windows/index.html">
+ Windows
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/osx/index.html">
+ OS X
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="this-page" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+
+ <span class="entry-highlight"></span>
+
+
+
+
+ <div id="page-toc" class="page-toc"></div>
+
+
+ </li>
+
+</ul>
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../platform_plugin_versioning_ref/index.html">
+ Manage versions and platforms
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../config_ref/images.html">
+ Customize icons
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../cordova/storage/storage.html">
+ Store data
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/appdev/privacy/index.html">
+ Manage privacy
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/appdev/security/index.html">
+ Manage security
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/appdev/whitelist/index.html">
+ Whitelisting
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+</ul>
+
+
+ </li>
+
+
+ <li>
+
+ <span class="toc-section-heading">
+ Create plugins
+ </span>
+
+
+
+
+
+
+ <ul class="site-toc">
+
+
+ <li>
+
+ <a class="" href="../../../guide/hybrid/plugins/index.html">
+ Create a plugin
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <span class="toc-section-heading">
+ Develop for platforms
+ </span>
+
+
+
+
+
+
+ <ul class="site-toc">
+
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/android/plugin.html">
+ Android
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/ios/plugin.html">
+ iOS
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/windows/plugin.html">
+ Windows
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+</ul>
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../plugin_ref/plugman.html">
+ Use Plugman
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+</ul>
+
+
+ </li>
+
+
+ <li>
+
+ <span class="toc-section-heading">
+ Advanced Topics
+ </span>
+
+
+
+
+
+
+ <ul class="site-toc">
+
+
+ <li>
+
+ <a class="" href="../../../guide/hybrid/webviews/index.html">
+ Embed Cordova in native apps
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/next/index.html">
+ Next Steps
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+</ul>
+
+
+ </li>
+
+
+ <li>
+
+ <span class="toc-section-heading">
+ Reference
+ </span>
+
+
+
+
+
+
+ <ul class="site-toc">
+
+
+ <li>
+
+ <a class="" href="../../../config_ref/index.html">
+ Config.xml
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../cordova/events/events.html">
+ Events
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-cli/index.html">
+ CLI Reference
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../guide/appdev/hooks/index.html">
+ Hooks
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../plugin_ref/spec.html">
+ Plugin.xml
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <span class="toc-section-heading">
+ Plugin APIs
+ </span>
+
+
+
+
+
+
+ <ul class="site-toc">
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-battery-status/index.html">
+ Battery Status
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-camera/index.html">
+ Camera
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-device/index.html">
+ Device
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-dialogs/index.html">
+ Dialogs
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-file/index.html">
+ File
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-geolocation/index.html">
+ Geolocation
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-inappbrowser/index.html">
+ Inappbrowser
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-media/index.html">
+ Media
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-media-capture/index.html">
+ Media Capture
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-network-information/index.html">
+ Network Information
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-screen-orientation/index.html">
+ Screen Orientation
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-splashscreen/index.html">
+ Splashscreen
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-statusbar/index.html">
+ Statusbar
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-vibration/index.html">
+ Vibration
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+
+ <li>
+
+ <a class="" href="../../../reference/cordova-plugin-whitelist/index.html">
+ Whitelist
+ </a>
+
+
+
+
+
+
+
+ </li>
+
+</ul>
+
+
+ </li>
+
+</ul>
+
+
+ </li>
+
+</ul>
+
+ </div>
+
+ <!-- Page content -->
+ <div class="page-content-container">
+ <div class="page-content">
+ <div class="content-header">
+
+ <!-- ToC Dropdown (for XS and SM sizes only) -->
+ <div class="toc-dropdown dropdown visible-xs-block visible-sm-block">
+ <button class="btn btn-default dropdown-toggle" type="button" id="tocDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
+ Table of Contents
+ <span class="caret"></span>
+ </button>
+ <ul class="dropdown-menu">
+
+
+
+
+
+<li>
+ <a class="" href="../../../guide/overview/index.html">
+ Overview
+ </a>
+</li>
+
+
+
+
+
+
+
+
+
+
+<li>
+ <a class="" href="../../../guide/cli/index.html">
+ Create your first app
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/cli/template.html">
+ Templates for apps
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/support/index.html">
+ Platform support
+ </a>
+</li>
+
+
+
+
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/android/index.html">
+ Android
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/ios/index.html">
+ iOS
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/windows/index.html">
+ Windows
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/osx/index.html">
+ OS X
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="this-page" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+</li>
+
+
+
+
+
+
+
+<li>
+ <a class="" href="../../../platform_plugin_versioning_ref/index.html">
+ Manage versions and platforms
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../config_ref/images.html">
+ Customize icons
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../cordova/storage/storage.html">
+ Store data
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/appdev/privacy/index.html">
+ Manage privacy
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/appdev/security/index.html">
+ Manage security
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/appdev/whitelist/index.html">
+ Whitelisting
+ </a>
+</li>
+
+
+
+
+
+
+
+
+
+
+<li>
+ <a class="" href="../../../guide/hybrid/plugins/index.html">
+ Create a plugin
+ </a>
+</li>
+
+
+
+
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/android/plugin.html">
+ Android
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/ios/plugin.html">
+ iOS
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/windows/plugin.html">
+ Windows
+ </a>
+</li>
+
+
+
+
+
+
+
+<li>
+ <a class="" href="../../../plugin_ref/plugman.html">
+ Use Plugman
+ </a>
+</li>
+
+
+
+
+
+
+
+
+
+
+<li>
+ <a class="" href="../../../guide/hybrid/webviews/index.html">
+ Embed Cordova in native apps
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/next/index.html">
+ Next Steps
+ </a>
+</li>
+
+
+
+
+
+
+
+
+
+
+<li>
+ <a class="" href="../../../config_ref/index.html">
+ Config.xml
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../cordova/events/events.html">
+ Events
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-cli/index.html">
+ CLI Reference
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../guide/appdev/hooks/index.html">
+ Hooks
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../plugin_ref/spec.html">
+ Plugin.xml
+ </a>
+</li>
+
+
+
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-battery-status/index.html">
+ Battery Status
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-camera/index.html">
+ Camera
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-device/index.html">
+ Device
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-dialogs/index.html">
+ Dialogs
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-file/index.html">
+ File
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-geolocation/index.html">
+ Geolocation
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-inappbrowser/index.html">
+ Inappbrowser
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-media/index.html">
+ Media
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-media-capture/index.html">
+ Media Capture
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-network-information/index.html">
+ Network Information
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-screen-orientation/index.html">
+ Screen Orientation
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-splashscreen/index.html">
+ Splashscreen
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-statusbar/index.html">
+ Statusbar
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-vibration/index.html">
+ Vibration
+ </a>
+</li>
+
+
+
+
+<li>
+ <a class="" href="../../../reference/cordova-plugin-whitelist/index.html">
+ Whitelist
+ </a>
+</li>
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a class="edit" href="https://github.com/apache/cordova-docs/tree/master/www/docs/en/dev/guide/platforms/electron/index.md"><span class="glyphicon glyphicon-pencil" aria-hidden="true"></span> Edit Source on GitHub</a>
+
+
+
+ <!-- Language dropdown -->
+ <div class="dropdown">
+ <button class="btn btn-default dropdown-toggle" type="button" id="languageDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
+ English
+ <span class="caret"></span>
+ </button>
+
+ <!-- List all languages -->
+ <ul class="dropdown-menu" aria-labelledby="languageDropdown">
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/de/dev/guide/platforms/electron/index.html" class="">
+
+ Deutsch
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/en/dev/guide/platforms/electron/index.html" class="">
+
+ <span class="selected">
+ English
+ </span>
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/es/dev/guide/platforms/electron/index.html" class="">
+
+ Español
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/fr/dev/guide/platforms/electron/index.html" class="">
+
+ Français
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/it/dev/guide/platforms/electron/index.html" class="">
+
+ Italiano
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/ja/dev/guide/platforms/electron/index.html" class="">
+
+ æ¥æ¬èª
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/ko/dev/guide/platforms/electron/index.html" class="">
+
+ íêµì´
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/pl/dev/guide/platforms/electron/index.html" class="">
+
+ Polski
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/ru/dev/guide/platforms/electron/index.html" class="">
+
+ Ð ÑÑÑкий
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/sl/dev/guide/platforms/electron/index.html" class="">
+
+ Slovene
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/zh-cn/dev/guide/platforms/electron/index.html" class="">
+
+ ç®ä½ä¸æ
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li>
+ <a href="/docs/zh-tw/dev/guide/platforms/electron/index.html" class="">
+
+ ç¹é«ä¸æ
+
+ </a>
+ </li>
+
+ </ul>
+ </div>
+
+ <!-- Version dropdown -->
+ <div class="dropdown">
+ <button class="btn btn-default dropdown-toggle" type="button" id="versionDropdown" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
+ dev
+
+ <span class="caret"></span>
+ </button>
+ <ul class="dropdown-menu" aria-labelledby="versionDropdown">
+
+ <!-- List versions available in this language -->
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/dev/guide/platforms/electron/index.html" class="">
+
+ <span class="selected">
+
+ dev
+
+
+ </span>
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/latest/" class="missing-page">
+
+
+ 8.x
+
+ (Latest)
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/7.x/" class="missing-page">
+
+
+ 7.x
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/6.x/" class="missing-page">
+
+
+ 6.x
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/5.4.0/" class="missing-page">
+
+
+ 5.4.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/5.1.1/" class="missing-page">
+
+
+ 5.1.1
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/5.0.0/" class="missing-page">
+
+
+ 5.0.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/4.0.0/" class="missing-page">
+
+
+ 4.0.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/3.6.0/" class="missing-page">
+
+
+ 3.6.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/3.5.0/" class="missing-page">
+
+
+ 3.5.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/3.4.0/" class="missing-page">
+
+
+ 3.4.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/3.3.0/" class="missing-page">
+
+
+ 3.3.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/3.2.0/" class="missing-page">
+
+
+ 3.2.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/3.1.0/" class="missing-page">
+
+
+ 3.1.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/3.0.0/" class="missing-page">
+
+
+ 3.0.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.9.0/" class="missing-page">
+
+
+ 2.9.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.8.0/" class="missing-page">
+
+
+ 2.8.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.7.0/" class="missing-page">
+
+
+ 2.7.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.6.0/" class="missing-page">
+
+
+ 2.6.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.5.0/" class="missing-page">
+
+
+ 2.5.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.4.0/" class="missing-page">
+
+
+ 2.4.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.3.0/" class="missing-page">
+
+
+ 2.3.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.2.0/" class="missing-page">
+
+
+ 2.2.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.1.0/" class="missing-page">
+
+
+ 2.1.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/2.0.0/" class="missing-page">
+
+
+ 2.0.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/1.9.0/" class="missing-page">
+
+
+ 1.9.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/1.8.1/" class="missing-page">
+
+
+ 1.8.1
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/1.8.0/" class="missing-page">
+
+
+ 1.8.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/1.7.0/" class="missing-page">
+
+
+ 1.7.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/1.6.1/" class="missing-page">
+
+
+ 1.6.1
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/1.6.0/" class="missing-page">
+
+
+ 1.6.0
+
+
+
+ </a>
+ </li>
+
+ <li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <a href="/docs/en/1.5.0/" class="missing-page">
+
+
+ 1.5.0
+
+
+
+ </a>
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+
+
+
+
+
+
+
+
+ <!-- Show warnings for special versions -->
+ <!-- dev warning -->
+
+ <div class="alert docs-alert alert-info" role="alert">
+ <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+ <span aria-hidden="true">×</span>
+ </button>
+ This version of the documentation is under development!
+ <a href="/docs/en/latest/">
+ Click here for the latest released version.
+ </a>
+ </div>
+
+
+ <!-- outdated warning -->
+
+
+ <!-- plugin version warning -->
+
+
+ <div id="page-toc-source">
+ <h1>Electron Platform Guide</h1>
+
+<p>Electron is a framework that uses web technologies (HTML, CSS, and JS) to build cross-platform desktop applications.</p>
+
+<h2>Requirements and Support</h2>
+
+<h3>Linux</h3>
+
+<p><strong>@todo Add Linux Requirements here.</strong></p>
+
+<h3>Mac</h3>
+
+<ul>
+<li><p><strong>Xcode</strong>, the IDE for macOS, comes bundled with necessary software development tools to code signing and compiling native code for macOS.</p></li>
+<li><p><strong>RedHat Build Support</strong></p>
+
+<ul>
+<li><strong>Homebrew</strong>, one of the available macOS package manager, is used for installing additional tools and dependencies. Homebrew will be needed to install RPM packaging dependencies. <a href="https://brew.sh/"><strong>Brew Install Step</strong></a></li>
+<li><strong>RPM</strong>, a standard package manager for multiple Linux distributions, is the tool used for creating the Linux RPM package. To install this tool, use the following <a href="https://brew.sh/"><strong>Homebrew</strong></a> command:</li>
+</ul>
+<div class="highlight"><pre><code class="language-" data-lang="">$ brew install rpm
+</code></pre></div></li>
+</ul>
+
+<h3>Windows</h3>
+
+<p><strong>@todo Review and Update Windows Requirements.</strong></p>
+
+<ul>
+<li><strong>PowerShell</strong>, for Windows 7 users, must be at version 3.0 or greater for <a href="https://www.electron.build/code-signing#windows">app signing</a>.</li>
+</ul>
+
+<h2>Quick Start</h2>
+
+<h3>Create a Project</h3>
+<div class="highlight"><pre><code class="language-" data-lang="">$ npm i -g cordova
+$ cordova create sampleApp
+$ cd sampleApp
+$ cordova platform add electron
+</code></pre></div>
+<h3>Preview a Project</h3>
+
+<p>It is not necessary to build the Electron application for previewing. Since the building process can be slow, it is recommended to pass in the <code>--no-build</code> flag to disable the build process when previewing.</p>
+<div class="highlight"><pre><code class="language-" data-lang="">$ cordova run electron --no-build
+</code></pre></div>
+<h3>Build a Project</h3>
+
+<p><strong>Debug Builds</strong></p>
+<div class="highlight"><pre><code class="language-" data-lang="">$ cordova build electron
+$ cordova build electron --debug
+</code></pre></div>
+<p><strong>Release Builds</strong></p>
+<div class="highlight"><pre><code class="language-" data-lang="">$ cordova build electron --release
+</code></pre></div>
+<h2>Customizing the Application's Main Process</h2>
+
+<p>In the <code>{PROJECT_ROOT_DIR}/platform/electron/platform_www/</code> directory, the file <code>main.js</code> defines the application's main process. We can customize the application's window appearance as well as defining or enabling additional features in this file.</p>
+
+<h3>Window Appearance (BrowserWindow)</h3>
+
+<p>Electron provides many options to manipulate the BrowserWindow. This section covers only a few basic options. For a full list of options, please see the <a href="https://electronjs.org/docs/api/browser-window#new-browserwindowoptions">Electron's Docs - BrowserWindow Options</a>.</p>
+
+<p>Electron provides many optional options that can manipulate the BrowserWindow. This section will cover a few of these options that many uses. A full list of these options can be found on the </p>
+
+<h4>How to set the window default size?</h4>
+
+<p>Using the <code>width</code> and <code>height</code> option, you can define starting default window size.</p>
+<div class="highlight"><pre><code class="language-" data-lang="">mainWindow = new BrowserWindow({
+ width: 800,
+ height: 600
+});
+</code></pre></div>
+<h4>How to make the window not resizable?</h4>
+
+<p>Using the <code>resizable</code> flag option, you can disable the user's ability to resize your application's window.</p>
+<div class="highlight"><pre><code class="language-" data-lang="">mainWindow = new BrowserWindow({ resizable: false });
+</code></pre></div>
+<h4>How to make my window fullscreen?</h4>
+
+<p>Using the <code>fullscreen</code> flag option, you can force the application to launch in fullscreen.</p>
+<div class="highlight"><pre><code class="language-" data-lang="">mainWindow = new BrowserWindow({ fullscreen: true });
+</code></pre></div>
+<h3>DevTools</h3>
+
+<p>The <code>--release</code> and <code>--debug</code> flags control the visibility of the DevTools. DevTools are shown by default on <strong>Debug Builds</strong> (<code>without a flag</code> or with <code>--debug</code>). If you want to hide the DevTools pass in the <code>--release</code> flag when building or running the application.</p>
+
+<p><em>Note: DevTools still can be closed or opened manually.</em></p>
+
+<h2>Build Configurations</h2>
+
+<h3>Default Build Configurations</h3>
+
+<p>By default, with no additional configuration, <code>cordova build electron</code> will build default packages for the host operating system (OS) that triggers the command. Below, are the list of default packages for each OS.</p>
+
+<p><strong>Linux</strong></p>
+
+<table><thead>
+<tr>
+<th>Package</th>
+<th style="text-align: center">Arch</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>tar.gz</td>
+<td style="text-align: center">x64</td>
+</tr>
+</tbody></table>
+
+<p><strong>Mac</strong></p>
+
+<table><thead>
+<tr>
+<th>Package</th>
+<th style="text-align: center">Arch</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>dmg</td>
+<td style="text-align: center">x64</td>
+</tr>
+<tr>
+<td>zip</td>
+<td style="text-align: center">x64</td>
+</tr>
+</tbody></table>
+
+<p><strong>Windows</strong></p>
+
+<table><thead>
+<tr>
+<th>Package</th>
+<th style="text-align: center">Arch</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>nsis</td>
+<td style="text-align: center">x64</td>
+</tr>
+</tbody></table>
+
+<h3>Customizing Build Configurations</h3>
+
+<p>If for any reason you would like to customize the build configurations, modifications are placed within the <code>build.json</code> file located in the project's root directory. E.g. <code>{PROJECT_ROOT_DIR}/build.json</code>. This file contains all build configurations for all platforms (Android, Electron, iOS, Windows).</p>
+
+<p><strong>Example Config Structure</strong></p>
+<div class="highlight"><pre><code class="language-" data-lang="">{
+ "electron": {}
+}
+</code></pre></div>
+<p>Since the Electron framework is for creating cross-platform applications, multiple configurations are required for each OS build. The <code>electron</code> node, in the <code>build.json</code> file, contains three properties that separate the build configurations for each OS.</p>
+
+<p><strong>Example Config Structure with Each Platform</strong></p>
+<div class="highlight"><pre><code class="language-" data-lang="">{
+ "electron": {
+ linux: {},
+ mac: {},
+ windows: {}
+ }
+}
+</code></pre></div>
+<p>Each OS node contains properties that are used to identify what package to generate and how to sign.</p>
+
+<p><strong>OS Properties:</strong></p>
+
+<ul>
+<li><code>package</code> is an array of package formats that will be generated.</li>
+<li><code>arch</code> is an array of architectures that each package is built for.</li>
+<li><code>signing</code> is an object that contains signing information. See <a href="#signing-configurations">Signing Configurations</a> for more information.</li>
+</ul>
+
+<p>Any properties that are undefined will fallback to default values.</p>
+
+<h4>Adding a <code>package</code></h4>
+
+<p>The <code>package</code> property is an array list of packages to be outputted. If the property is defined, the default packages are not used unless added. The order of the packages has no importance.</p>
+
+<p>The configuration example below will generate <code>tar.gz</code>, <code>dmg</code> and <code>zip</code> packages for macOS.</p>
+<div class="highlight"><pre><code class="language-" data-lang="">{
+ "electron": {
+ "mac": {
+ "package": [
+ "dmg",
+ "tar.gz",
+ "zip"
+ ]
+ }
+ }
+}
+</code></pre></div>
+<p><strong>Available Packages by Operating System</strong></p>
+
+<table><thead>
+<tr>
+<th>Package Type</th>
+<th style="text-align: center">Linux</th>
+<th style="text-align: center">macOS</th>
+<th style="text-align: center">Windows</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>default</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center"><code>dmg</code><br /><code>zip</code></td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>dmg</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>mas</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>mas-dev</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>pkg</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>7z</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>zip</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>tar.xz</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>tar.lz</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>tar.gz</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>tar.bz2</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>dir</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>nsis</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>nsis-web</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>portable</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>appx</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">:white<em>check</em>mark: <sup><strong>[1]</strong></sup></td>
+</tr>
+<tr>
+<td>msi</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+<tr>
+<td>AppImage</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>snap</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>deb</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>rpm</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>freebsd</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>pacman</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>p5p</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+</tr>
+<tr>
+<td>apk</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">-</td>
+<td style="text-align: center">-</td>
+</tr>
+</tbody></table>
+
+<ul>
+<li><strong>[1]</strong> Only Window 10 can build AppX packages.</li>
+</ul>
+
+<h4>Setting the package <code>arch</code></h4>
+
+<p>The <code>arch</code> property is an array list of architectures that each package is built for. When the property is defined, the default arch is not used unless added.</p>
+
+<blockquote>
+<p>:warning: Not all architectures are available for every operating system. Please review the <a href="https://github.com/electron/electron/releases/">Electron Releases</a> to identify valid combinations. For example, macOS (Darwin) only supports x64.</p>
+</blockquote>
+
+<p><strong>Available Arch</strong></p>
+
+<ul>
+<li>ia32</li>
+<li>x64</li>
+<li>armv71</li>
+<li>arm64</li>
+</ul>
+
+<p>The example above will generate a <code>x64</code> <code>dmg</code> package.</p>
+<div class="highlight"><pre><code class="language-" data-lang="">{
+ "electron": {
+ "mac": {
+ "package": [
+ "dmg"
+ ],
+ "arch": ["x64"]
+ }
+ }
+}
+</code></pre></div>
+<h3>Multi-Platform Build Support</h3>
+
+<blockquote>
+<p>:warning: Not all platforms support this feature and may have limitations.</p>
+</blockquote>
+
+<p>Building for multiple platforms on a single operating system may possible but has limitations. It is recommended that the builder's operating system (host OS) matches with the platform that is being built.</p>
+
+<p>The matrix below shows each host OS and for which platforms they are capable of building applications.</p>
+
+<table><thead>
+<tr>
+<th>Host <sup><strong>[1]</strong></sup></th>
+<th style="text-align: center">Linux</th>
+<th style="text-align: center">Mac</th>
+<th style="text-align: center">Window</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>Linux</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center"></td>
+<td style="text-align: center">:warning: <sup><strong>[2]</strong></sup></td>
+</tr>
+<tr>
+<td>Mac <sup><strong>[3]</strong></sup></td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+<td style="text-align: center">:warning: <sup><strong>[2]</strong></sup></td>
+</tr>
+<tr>
+<td>Window</td>
+<td style="text-align: center"></td>
+<td style="text-align: center"></td>
+<td style="text-align: center">:white<em>check</em>mark:</td>
+</tr>
+</tbody></table>
+
+<p><strong>Limitations:</strong></p>
+
+<ul>
+<li><strong>[1]</strong> If the app contains native dependency, it can only be compiled on the targeted platform.</li>
+<li><strong>[2]</strong> Linux and macOS are unable to build Windows Appx packages for Windows Store.</li>
+<li><strong>[3]</strong> <a href="https://www.electron.build/multi-platform-build#macos">All required system dependencies, except rpm, will be downloaded automatically on demand. RPM can be installed with brew. (macOS Sierra 10.12+)</a></li>
+</ul>
+
+<p>The example below enables multi-platform build for all OS and uses the default build configurations.</p>
+<div class="highlight"><pre><code class="language-" data-lang="">{
+ "electron": {
+ "linux": {},
+ "mac": {},
+ "windows": {}
+ }
+}
+</code></pre></div>
+<h2>Signing Configurations</h2>
+
+<h3>macOS Signing</h3>
+
+<p>There are three types of signing targets. (<code>debug</code>, <code>release</code>, and <code>store</code>). Each section has the following properties:</p>
+
+<table><thead>
+<tr>
+<th>key</th>
+<th>description</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>entitlements</td>
+<td>String path value to entitlements file.</td>
+</tr>
+<tr>
+<td>entitlementsInherit</td>
+<td>String path value to the entitlements file which inherits the security settings.</td>
+</tr>
+<tr>
+<td>identity</td>
+<td>String value of the name of the certificate.</td>
+</tr>
+<tr>
+<td><a href="https://developer.apple.com/library/archive/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html">requirements</a></td>
+<td>String path value of requirements file. <br /><br />:warning: This is not available for the <code>mas</code> (store) signing configurations.</td>
+</tr>
+<tr>
+<td>provisioningProfile</td>
+<td>String path value of the provisioning profile.</td>
+</tr>
+</tbody></table>
+
+<p><strong>Example Config:</strong></p>
+<div class="highlight"><pre><code class="language-" data-lang="">{
+ "electron": {
+ "mac": {
+ "package": [
+ "dmg",
+ "mas",
+ "mas-dev",
+ ],
+ "signing": {
+ "release": {
+ "identity": "APACHE CORDOVA (TEAMID)",
+ "provisioningProfile": "release.mobileprovision"
+ }
+ }
+ }
+ }
+}
+</code></pre></div>
+<p>For macOS signing, there are a few exceptions to how the signing information is used.
+By default, all packages with the exception of <code>mas</code> and <code>mas-dev</code>, use the <code>debug</code> and <code>release</code> signing configurations.</p>
+
+<p>Using the example config above, let's go over some use cases to better understand the exceptions.</p>
+
+<p><strong>Use Case 1:</strong></p>
+<div class="highlight"><pre><code class="language-" data-lang="">$ cordova build electron --debug
+</code></pre></div>
+<p>The command above will:</p>
+
+<ul>
+<li>Generate a <code>dmg</code> build and <code>mas-dev</code> build using the <code>debug</code> signing configurations.</li>
+<li>Ignore the <code>mas</code> target package.</li>
+</ul>
+
+<p><em>Use Case 2:</em></p>
+<div class="highlight"><pre><code class="language-" data-lang="">$ cordova build electron --release
+</code></pre></div>
+<p>The command above will:</p>
+
+<ul>
+<li>Generate a <code>dmg</code> build using the <code>release</code> config.</li>
+<li>Generate a <code>mas</code> build using the <code>store</code> config.</li>
+<li>Ignore the <code>mas-dev</code> target package.</li>
+</ul>
+
+<h3>Windows Signing</h3>
+
+<p>The signing information is comprised of two types. (<code>debug</code>, <code>release</code>). Each section has the following properties:</p>
+
+<table><thead>
+<tr>
+<th>key</th>
+<th>description</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>certificateFile</td>
+<td>String path to the certificate file.</td>
+</tr>
+<tr>
+<td>certificatePassword</td>
+<td>String value of the certificate file's password.<br /><br /><strong>Alternative</strong>: The password can be set on the environment variable <code>CSC_KEY_PASSWORD</code>.</td>
+</tr>
+<tr>
+<td>certificateSubjectName</td>
+<td>String value of the signing certificate's subject.<br /><br />:warning: Required for EV Code Signing and requires Windows</td>
+</tr>
+<tr>
+<td>certificateSha1</td>
+<td>String value of the SHA1 hash of the signing certificate.<br /><br />:warning: Requires Windows</td>
+</tr>
+<tr>
+<td>signingHashAlgorithms</td>
+<td>Collection of singing algorithms to be used. (<code>sha1</code>, <code>sha256</code>)<br /><br />:warning: AppX builds only support <code>sha256</code></td>
+</tr>
+<tr>
+<td>additionalCertificateFile</td>
+<td>String path to the additional certificate files.</td>
+</tr>
+</tbody></table>
+
+<p><strong>Example Config:</strong></p>
+<div class="highlight"><pre><code class="language-" data-lang="">{
+ "electron": {
+ "windows": {
+ "package": [
+ "nsis"
+ ],
+ "signing": {
+ "release": {
+ "certificateFile": "path_to_files",
+ "certificatePassword": "password"
+ }
+ }
+ }
+ }
+}
+</code></pre></div>
+<h3>Linux Signing</h3>
+
+<p>There are not signing requirements for Linux builds.</p>
+
+<h2>Plugins</h2>
+
+<p>All browser-based plugins are usable with the Electron platform.</p>
+
+<p>When adding a plugin, if the plugin supports both the <code>electron</code> and <code>browser</code> platform, the <code>electron</code> portion will be used. If the plugin misses <code>electron</code>, but contains the <code>browser</code> implementation, it will fall back on the <code>browser</code> implementation.</p>
+
+<p>Internally, Electron is using Chromium (Chrome) as its web view. Some plugins may have conditions written specifically for each different browser. In this case, it may affect the behavior from what is intended. Since Electron may support feature that the browser does not, these plugins would possibly need to be updated for the <code>electron</code> platform.</p>
+
+
+ </div>
+ </div>
+ <div class="row">
+ <div class="blue-divider"></div>
+<footer>
+ <div class="container-fluid">
+ <div class="row">
+ <div class="col-sm-9">
+ <h1>More Resources</h1>
+ <div class="row">
+ <div class="col-sm-4">
+ <h2>General</h2>
+ <ul class="nav">
+ <li>
+ <a target="_blank" href="https://projects.apache.org/project.html?cordova">Apache Project Page</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/dyn/closer.cgi/cordova">Source Distribution</a>
+ </li>
+ <li>
+ <a target="_blank" href="http://www.apache.org/licenses/LICENSE-2.0">License</a>
+ </li>
+ <li>
+ <a href="/artwork">Artwork</a>
+ </li>
+ </ul>
+ </div>
+ <div class="col-sm-4">
+ <h2>Development</h2>
+ <ul class="nav">
+ <li><a target="_blank" href="https://github.com/apache?utf8=%E2%9C%93&q=cordova-">Source Code</a></li>
+ <li><a target="_blank" href="https://issues.apache.org/jira/browse/CB/">Issue Tracker</a></li>
+ <li><a target="_blank" href="http://stackoverflow.com/questions/tagged/cordova">Stack Overflow</a></li>
+ <li><a href="/contact">Mailing List</a></li>
+ <li><a href="/contribute/nightly_builds.html">Nightly builds</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-4">
+ <h2>Apache Software Foundation</h2>
+ <ul class="nav">
+ <li>
+ <a target="_blank" href="http://www.apache.org/">About ASF</a>
+ </li>
+ <li>
+ <a target="_blank" href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a>
+ </li>
+ <li>
+ <a target="_blank" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+ </li>
+ <li>
+ <a target="_blank" href="http://www.apache.org/security/">Security</a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ <div class="col-sm-3">
+ <h1>Contribute</h1>
+ <p style="padding-top:20px"><strong>Help Cordova move forward!</strong></p>
+ <p>Report bugs, improve the docs, or contribute to the code.</p>
+ <a href="/contribute" class="btn btn-lg btn-primary">
+ Learn More
+ </a>
+ <p style="padding-top:20px"> <a href="https://twitter.com/apachecordova" class="twitter-follow-button" data-show-count="false">Follow @apachecordova</a></p>
+ <script async defer src="https://slack-cordova-io.herokuapp.com/slackin.js"></script>
+ </div>
+</div>
+<p class="copyright_text">
+ Copyright © 2012, 2013, 2015 The Apache Software Foundation, Licensed under the <a target="_blank" href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br/>
+ Apache and the Apache feather logos are <a target="_blank" href="http://www.apache.org/foundation/marks/list/">trademarks</a> of The Apache Software Foundation.
+ <br/>
+ "Raleway" font used under license. For details see the <a href="/attributions/">attributions page</a>.
+</p>
+
+ </div>
+</footer>
+
+ </div>
+ </div>
+</div>
+
+<script defer type="text/javascript" src="/static/js/lib/toc.min.js"></script>
+<script defer type="text/javascript" src="/static/js/docs.js"></script>
+
+ <script defer type="text/javascript" src="/static/js/index.js"></script>
+ <script defer type="text/javascript" src="/static/js/twitter.js"></script>
+
+
+
+
+
+
+
+
+<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+<script type="text/javascript">
+ docsearch({
+ apiKey: '0a916ab198bd93d031aa70611271e42e',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': ["version: dev", "language: en"] }
+ });
+</script>
+
+</body>
+</html>
Modified: cordova/site/public/docs/en/dev/guide/platforms/ios/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/ios/index.html?rev=1854748&r1=1854747&r2=1854748&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/ios/index.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/ios/index.html Mon Mar 4 03:01:54 2019
@@ -305,6 +305,21 @@
</li>
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+
+
+
+
+
+
+
+ </li>
+
</ul>
@@ -1004,6 +1019,15 @@
</a>
</li>
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+</li>
+
Modified: cordova/site/public/docs/en/dev/guide/platforms/ios/plugin.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/ios/plugin.html?rev=1854748&r1=1854747&r2=1854748&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/ios/plugin.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/ios/plugin.html Mon Mar 4 03:01:54 2019
@@ -303,6 +303,21 @@
</li>
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+
+
+
+
+
+
+
+ </li>
+
</ul>
@@ -1004,6 +1019,15 @@
</a>
</li>
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+</li>
+
Modified: cordova/site/public/docs/en/dev/guide/platforms/ios/upgrade.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/ios/upgrade.html?rev=1854748&r1=1854747&r2=1854748&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/ios/upgrade.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/ios/upgrade.html Mon Mar 4 03:01:54 2019
@@ -303,6 +303,21 @@
</li>
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+
+
+
+
+
+
+
+ </li>
+
</ul>
@@ -1002,6 +1017,15 @@
</a>
</li>
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+</li>
+
Modified: cordova/site/public/docs/en/dev/guide/platforms/ios/webview.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/ios/webview.html?rev=1854748&r1=1854747&r2=1854748&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/ios/webview.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/ios/webview.html Mon Mar 4 03:01:54 2019
@@ -303,6 +303,21 @@
</li>
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+
+
+
+
+
+
+
+ </li>
+
</ul>
@@ -1002,6 +1017,15 @@
</a>
</li>
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+</li>
+
Modified: cordova/site/public/docs/en/dev/guide/platforms/osx/config.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/osx/config.html?rev=1854748&r1=1854747&r2=1854748&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/osx/config.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/osx/config.html Mon Mar 4 03:01:54 2019
@@ -303,6 +303,21 @@
</li>
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+
+
+
+
+
+
+
+ </li>
+
</ul>
@@ -1002,6 +1017,15 @@
</a>
</li>
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+</li>
+
Modified: cordova/site/public/docs/en/dev/guide/platforms/osx/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/osx/index.html?rev=1854748&r1=1854747&r2=1854748&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/osx/index.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/osx/index.html Mon Mar 4 03:01:54 2019
@@ -305,6 +305,21 @@
</li>
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+
+
+
+
+
+
+
+ </li>
+
</ul>
@@ -1004,6 +1019,15 @@
</a>
</li>
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+</li>
+
Modified: cordova/site/public/docs/en/dev/guide/platforms/osx/plugin.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/osx/plugin.html?rev=1854748&r1=1854747&r2=1854748&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/osx/plugin.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/osx/plugin.html Mon Mar 4 03:01:54 2019
@@ -303,6 +303,21 @@
</li>
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+
+
+
+
+
+
+
+ </li>
+
</ul>
@@ -1002,6 +1017,15 @@
</a>
</li>
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+</li>
+
Modified: cordova/site/public/docs/en/dev/guide/platforms/windows/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/windows/index.html?rev=1854748&r1=1854747&r2=1854748&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/windows/index.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/windows/index.html Mon Mar 4 03:01:54 2019
@@ -305,6 +305,21 @@
</li>
+
+ <li>
+
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+
+
+
+
+
+
+
+ </li>
+
</ul>
@@ -1004,6 +1019,15 @@
</a>
</li>
+
+
+
+<li>
+ <a class="" href="../../../guide/platforms/electron/index.html">
+ Electron
+ </a>
+</li>
+
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org