Commit graph

3837 commits

Author SHA1 Message Date
Mod John
2a161e1725 Fix broken link (#12387)
* Fix broken link

Link was producing a 404 error as the file no longer exists. Wasn't sure where this intended link used to go so took a guess at a appropriate target.

* Update quick-start.md
2018-05-16 10:23:46 -07:00
John Kleinschmidt
9488ef4867
Merge pull request #12496 from mikeykhalil/8952-ignore-tray-double-click-events
8952 option to ignore tray double click events
2018-05-16 10:17:36 -04:00
Milan Burda
211d7825d3 feat: DIP <-> screen coordinate conversions (#12879) 2018-05-16 18:34:09 +09:00
Milan Burda
56cdf94f95 Fix contents.setSize(options) documentation in web-contents.md (#12922) 2018-05-15 10:17:04 +10:00
Samuel Attard
0bb29e092d
fix: update docs for the ts parser (#12902) 2018-05-12 18:12:28 +10:00
Charles Kerr
5354e804d0 Fix oops: remove duplicate doc from last commit 2018-05-11 13:27:35 -05:00
Charles Kerr
bdae243552 Reinstate docs for app.makeSingleInstance()
Since this method is mentioned in breaking-changes.md, we need
the docs to prevent create-typescript-definitions from failing with
"error TS2339: Property 'makeSingleInstance' does not exist on type 'App'."

The reinstated docs are marked with deprecation warnings
that refer the reader to the new API calls.
2018-05-11 13:17:11 -05:00
Charles Kerr
13877ce2c8 Fix routingId type
Previous phrasing confused electron-typescript-definitions,
thinking that routingId was of type `unique` 😃
2018-05-11 13:05:05 -05:00
Charles Kerr
8acbfca06b Make Referrer.policy types parseable by e-t-d 2018-05-11 12:40:46 -05:00
Charles Kerr
cf6d36cb72 Consistent docs for LoadURLOptions.httpReferrer 2018-05-11 12:18:38 -05:00
Zeke Sikelianos
1cc5492784
Merge pull request #12870 from electron/remove-macci-refs
Remove references to no longer used https://mac-ci.electronjs.org
2018-05-09 22:25:57 -07:00
John Kleinschmidt
fd8e330760 Remove references to no longer used https://mac-ci.electronjs.org 2018-05-09 16:41:24 -04:00
Shelley Vohr
daf75dd375
add app.isPackaged (#12656)
* add isPackaged method

* add false test case for app.isPackaged()

* document add.isPackaged()

* check isPackaged() without fs call

* convert to non-method property

* document app.isPackaged as a property

* update tests for app.isPackaged

* remove unused fs require

* clarify docs for isPackaged()
2018-05-07 23:15:31 -07:00
Charles Kerr
4d078fdb03
Remove more words (#12852)
* remove 'basically' from docs

* remove 'simply' from docs

* remove most uses of 'just' from docs
2018-05-08 00:16:09 -05:00
John Kleinschmidt
c13d1e8ae6
Merge pull request #12847 from electron/friendly-docs
Remove judgmental docs terms
2018-05-07 12:41:17 -04:00
Shelley Vohr
52e3d5e4f0
remove some beginner-unfriendly terms from docs 2018-05-07 08:46:14 -07:00
Samuel Attard
5b5c161601
feat: new makeSingleInstance API (#12782)
* Refactor app.makeSingleInstance
* new API `app.isPrimaryInstance()`
* new API `app.isSingleInstance()`
* new event `app.on('second-instance')`
* deprecated old syntax `app.makeSingleInstance(cb)`
* deprecated old syntax of `app.makeSingleInstance() --> bool` in favor
of `app.isPrimaryInstance()`
* Fix spec, we don't need process.nextTick hacks any more
* Make deprecation TODO for the return value of makeSingleInstance
* Refactor makeSingleInstance to requestSingleInstanceLock and add appropriate deprecation comments
* I swear this isn't tricking the linter
* Make const
* Add deprecation warnings for release, and add to planned-breaking-changes

BREAKING CHANGE
2018-05-08 01:29:18 +10:00
Shelley Vohr
9c8952aef0
Add menu item order control (#12362)
Add four new optional properties to menus in Electron. The four properties are:
'before'
'after'
'beforeGroupContaining'
'afterGroupContaining'

'before/after' - provides a means for a single context menu item to declare its placement relative to another context menu item. These also imply that menu item in question should be placed in the same “group” as the item.

'beforeGroupContaining/afterGroupContaining - provides a means for a single menu item to declare the placement of its containing group, relative to the containing group of the specified item.
2018-05-05 09:37:29 -07:00
mikeykhalil
3aba515bbc update docs for getIgnoreDoubleClickEvents method 2018-05-03 13:49:33 -07:00
mikeykhalil
664e14b91f fixed typo found in code review 2018-05-03 13:49:32 -07:00
mikeykhalil
e1dcd79e48 updated Tray API docs to include new setIgnoreDoubleClickEvents method 2018-05-03 13:49:32 -07:00
Stephan Lee
6646ef71da docs: fix the type information in in-app-purchase
Method returns Boolean, Manually confirmed the
correctness by running `npm run create-api-json`.
2018-05-03 09:34:21 -07:00
Rahat Ahmed
5ba9f6a966 docs: Fix typo in transaction.md (#12804) 2018-05-03 00:01:49 -05:00
David Chawei Hsu
091ddb3c34 Fixed several broken links to the sections (#12797) 2018-05-02 21:51:37 -05:00
Tim Fish
82329124ff Fixes #12710 (#12786) 2018-05-02 12:19:52 -04:00
Zeke Sikelianos
36c4519d7e
Merge pull request #12781 from electron/more-code-signing
More code signing docs
2018-05-02 08:39:03 -07:00
Charles Kerr
c81dac774a
Fix some broken documentation links (#12794) 2018-05-02 10:33:07 -05:00
Zeke Sikelianos
1957eb9429 summarize semantic commit requirements (#12665)
* summarize semantic commit requirements

* move semantic commit details into contributing docs

* keep those messages short
2018-05-02 09:47:26 -05:00
Samuel Attard
63d670c286 explain platform differences in code signing 2018-05-02 11:52:52 +10:00
Samuel Attard
94e6be6cae more code signing docs 2018-05-02 11:12:15 +10:00
Zeke Sikelianos
f1c7df8c28 add code signing tutorial (#12767)
* docs: add code signing tutorial

* docs: link to code signing tutorial from readme

* docs: remove unneeded use of "application" from docs readme
2018-05-01 19:56:44 -05:00
John Kleinschmidt
d355bf0267
Merge pull request #12756 from electron/support-policy
Support policy
2018-05-01 15:40:55 -04:00
Charles Kerr
2cecc6ec2c Remove text about ia32 emulator 2018-05-01 14:31:01 -05:00
Charles Kerr
49cab41fdf Tweak ARM support with suggestion from jkleinsc 2018-05-01 14:25:18 -05:00
Charles Kerr
b0a8d825b3 Clarify the text on Windows for ARM support 2018-05-01 13:40:21 -05:00
Charles Kerr
af60a2fdf6 Add placeholder for supported-platforms.md 2018-05-01 13:32:11 -05:00
Charles Kerr
b602714e06 Use correct Slack channel name 2018-05-01 13:31:48 -05:00
Zeke Sikelianos
013a28a527
Merge pull request #12736 from electron/update-updates-tutorial
document update.electronjs.org in updates tutorial
2018-05-01 09:17:37 -07:00
bughit
55a7f6f0ce add did-frame-navigate event to WebContents (#12723)
* add did-frame-navigate event to WebContents, pass http response code to it and did-navigate

* docs for frame routing id related api changes on WebFrame and WebContents
2018-05-01 13:34:41 +09:00
Charles Kerr
400fb79dc2 Fix tyop 2018-04-30 18:36:17 -05:00
Charles Kerr
7c5b70d304 Fix broken link 2018-04-30 18:33:40 -05:00
Charles Kerr
221b103721 Finish consolidating the finding-support section 2018-04-30 18:26:08 -05:00
Charles Kerr
c0dc2d0238 Copyedit the 'finding support' section 2018-04-30 18:11:10 -05:00
Charles Kerr
37a68aebcf Link issues.md back to support.md 2018-04-30 18:06:29 -05:00
Charles Kerr
a332930cdf add 'finding support' section 2018-04-30 17:58:19 -05:00
Charles Kerr
e44b62d5a3 copyediting 2018-04-30 17:17:42 -05:00
Charles Kerr
d76b0223d9 add end-of-support policy 2018-04-30 17:16:15 -05:00
Samuel Attard
338a816ffd
Screen Lock / Unlock events (#12714)
* initial lock-screen and unlock-screen event implementation for macOS

* Implementation of lock-screen and unlock-screen on windows
2018-05-01 02:04:27 +10:00
Zeke Sikelianos
21ffcbddad document update.electronjs.org in updates tutorial 2018-04-27 10:49:42 -07:00
Jeremy Apthorp
1a64b9f0c2 Disable navigating on drag/drop (#12655)
* Disable navigating on drag/drop

* Add a WebPreferences option to re-enable navigate on drag/drop
2018-04-26 10:23:27 -05:00
Nitish Sakhawalkar
2579071b98 Deprecate did-get-response-details and did-get-redirect-request (#12615)
* Deprecate webContents events did-get-response-details and did-get-redirect-request.

* Update guest view files

* Update webview tag docs and update specs

* Update deprecate.event function

* Update comment

* Update more

* Update documentation for other deprecated event
2018-04-23 14:46:12 -05:00
Leo MG Nesfield (LMGN)
975964f9f0 Not required. (#12682)
VS Code automatically executes from the `windows` object on win32.
2018-04-23 11:13:46 -05:00
James Wheare
bf2b4814e0 [docs] app.isDefaultProtocolClient is available on Linux now (#12674) 2018-04-23 01:16:43 +10:00
Paul Frazee
94236bf4eb Create automated-testing-with-a-custom-driver.md (#12446)
* Create automated-testing-with-a-custom-driver.md

* Update automated-testing-with-a-custom-driver.md

* Add 'Automated Testing with Custom Driver' to ToC

* Update automated-testing-with-a-custom-driver.md
2018-04-20 12:39:13 -04:00
Shelley Vohr
f9ee24f8f0
Merge pull request #12627 from vijaypushkin/patch-1
Corrected the name of Capitalization Styles
2018-04-20 09:49:28 -04:00
Alexey Kuzmin
fcc82ebd35 Add "app.whenReady()" (#12652)
* Make "chai-as-promised" avaialble in tests

* Add "app.whenReady()"

Closes #9561.
2018-04-20 17:09:23 +10:00
John Kleinschmidt
717f55b012
Merge pull request #11328 from electron/add-env-to-release-docs
expanded release docs
2018-04-18 11:28:16 -04:00
Zeke Sikelianos
40ff17c9f9
Merge pull request #12619 from electron/add-before-update-event
add new event to auto-updater
2018-04-16 12:43:15 -07:00
Shelley Vohr
4cb41ac425
clarify usage around before-quit-for-update event 2018-04-16 08:13:04 -04:00
Vijay Pushkin
82cbd4327f
Corrected the name of Capitalization Styles
Corrected CamelCase to PascalCase and 
mixedCase to camelCase
2018-04-16 13:14:11 +05:30
Birunthan Mohanathas
cd8278dceb Add missing event parameter to console-message (#12617) 2018-04-15 10:13:02 -05:00
Shelley Vohr
06892775d4
add new event to auto-updater 2018-04-14 21:29:36 -04:00
Zeke Sikelianos
e606a74de3
Merge pull request #12595 from Zhangdroid/fix-broken-url
[doc] Fix broken url
2018-04-13 19:08:20 -07:00
Zhuo Zhang
de1eae288c doc: rename 'blink-feature-string' as 'runtime-enabled-features'
make it more meaningful :)
2018-04-14 08:49:30 +08:00
Charles Kerr
03d119d539
Address @jkleinsc's 2018-03-21 comments 2018-04-13 16:10:53 -05:00
Zeke Sikelianos
23bb3bd963
Merge pull request #12577 from TiagoDanin-Forks/DeadURLs
[Docs] Fix dead urls
2018-04-13 11:04:11 -07:00
Zhuo Lu
a0cac05555 Clear cache storage data (#12546) 2018-04-13 13:03:16 -04:00
Zhuo Zhang
dd45473356 fix broken url for 'blink-feature-string' 2018-04-11 15:02:54 +08:00
TiagoDanin
d7a003b0bc
📝 Fix dead urls 2018-04-09 17:58:10 -03:00
Andreas
6b5e09478c Mouse forward on macOS (#12281)
* Accept mouse events according to the forward parameter on macOS.

* Update BrowserWindow docs: mouse forward is available on macOS
2018-04-09 19:35:05 +09:00
OJ Kwon
dabd61bf80 chore(build): support generating compilation db (#12104) 2018-04-09 14:54:14 +09:00
Andrew MacDonald
6bfb122cd1 Add a display_id parameter to the desktopCapturer API. (#12417)
* Add a screen_api_id parameter to the desktopCapturer API.

When using the DirectX capturer on Windows, there was previously no way
to associate desktopCapturer/getUserMedia and electron.screen API
screens. This new parameter provides the association.

* Fix non-Windows build.

* Fix Mac.

* Fix Mac harder.

* JS lint

* clang-format C++ code.

* IWYU

* display_id, Linux comment, better test

* lint

* Fix tests on Linux.

* Add display_id documentation.
2018-04-09 14:43:35 +09:00
Jeremy Apthorp
f0d08f4da1 Propagate referrer to new windows (#12397)
* Propagate referrer to new windows

Fixes #9205

* Rearrange -new-window event arguments for backwards-compatibility

* Plumb referrer policy through guest-window-manager

* Document the Referrer structure and its uses

* Add tests for referrer in new windows

* Docs nits
2018-04-05 18:13:24 -05:00
Natsu
7a01ff11cd
Fixed one minor grammatical issue
Line 93: "principals and methods" -> "principles and methods"
2018-04-05 19:26:26 +09:00
Adrien Fery
5486a65702 Improve in-app purchase for MacOS (#12464)
* Add methods to finish transactions

* Add a method to get the product descriptions from the App Store

* Improve the documentation of a transaction structure

* Add a tutorial for In App Purchase

* Fix typo in In-App Purchase tutorial

* Fix style of In-App Purchase files

* Fix In-App-Purchase product structure conversion in amr64

* Fix code style in In-App Purchase tutorial documentation

* Fix typos in In-App Purchase documentation

* Fix typo in In-App Purchase spec

* Slight style fixes
2018-04-05 15:33:13 +09:00
MadfishDT
200388ff96 add moveTop API to move window z-oder to top for win32, mac (#12485)
* add moveTop API to move window z-oder to top for win32, mac

* BrowserWindow::MoveTop SetMethod bug fix
2018-04-03 08:04:32 -05:00
Zeke Sikelianos
9d570dc645 add IDL and Mojo to glossary (#12504) 2018-04-03 07:58:25 -05:00
Sean
5f7c6ccfe4 update doc for setProgressBar (#12428)
* update doc for setProgressBar

The linter was unable to get `paused` as a possible value for `mode`

* update doc for setProgressBar

Addressing PR feedback
2018-03-28 10:29:31 +11:00
Jeremy Apthorp
22da843efa s/now/not/ in allowRunningInsecureContent documentation (#12452) 2018-03-28 10:15:29 +11:00
Samuel Attard
2e5cb930de Provide an easy way to use a local build of Electron (#12426)
* Provide an easy way to use a local build of Electron

For instance from ~/projects/electron/out/D

* document ELECTRON_OVERRIDE_DIST_PATH

* Make the linter happy

* Tweak ELECTRON_OVERRIDE_DIST_PATH docs
2018-03-25 00:03:17 -04:00
Charles Kerr
cfd91a3b56 Fix documentation tyop (#12422) 2018-03-23 18:35:14 -04:00
Jeremy Apthorp
95cbd69e48 Update testing docs to reflect --grep syntax (#12400)
* Update testing docs to reflect --grep syntax

* Use @zeke's suggestion to s/suites/tests/
2018-03-22 13:19:53 -04:00
Clément Beffa
642f5a84d4 Workspace notifications support on macOS (#12093) 2018-03-22 18:41:03 +09:00
htk3
6fa4ec22c5 fix broken fragment link in ipc-main.md (#12389) 2018-03-21 12:05:27 -05:00
bughit
37eccbcd33 Update 3 (of Visual Studio 2017) is leftover from 2015 (#12372)
does not apply to 2017
it's not clear to me that it's possible to download a non current version of vs2017
but if a specific version is required the directions should explain how to get it
2018-03-20 16:15:59 -05:00
Zeke Sikelianos
e3dfffb77b add docs/development/README.md (#12373) 2018-03-20 15:36:48 -04:00
Cheng Zhao
42938de973 Build with Visual Studio 2017 2018-03-20 10:13:16 +03:00
zhao-lin-li
bb73a0e2cb Update example code (#12315)
path and url needed to be require'd
2018-03-16 07:20:51 +09:00
Birunthan Mohanathas
2681e769a6 Document BrowserView.{destroy,isDestroyed} (#12274) 2018-03-15 16:15:56 +09:00
OJ Kwon
e7181eb89c feat(powerMonitor): expose interface to query system idle state (#11807)
* feat(BrowserWindow): expose interface to query system idle state

* test(BrowserWindow): update test cases for querySystemIdle interface

* docs(BrowserWindow): add querySystemIdle interface documentation

* refactor(powerMonitor): move querySystemIdle into powerMonitor

* test(powerMonitor): split test cases for all platform
2018-03-14 14:42:08 +09:00
Vanessa Yuen
48dd8f96b7 Fix broken links (#12232)
* Update system-preferences.md

* Fix broken documentation links.
2018-03-14 08:07:36 +09:00
Phil Freo
9d090e00f2 Make link to related guide/tutorial more obvious (#12204)
It's generally not a good practice to just link the word "here"
2018-03-10 23:04:07 +09:00
Vanessa Yuen
9c0e579bd3
Add heading for README 2018-03-09 20:16:56 +01:00
Jake
569b87ff83 Added session-created event documentation (#12123)
* Added session-created event documentation 

Emitted at 1c0ea0286e/lib/browser/api/session.js (L21)

* Removed trailing spaces
2018-03-08 11:32:52 +09:00
Samuel Attard
8c138e74be More vibrancy fixes (#12157)
* Only set title bar to transparent when vibrant with a custom titlebar
* Correctly set the transparent state of the GpuSwitcher so vibrancy works on reload
* Document case where using frame: false without custom titleBarStyle and vibrant
2018-03-07 11:40:36 -05:00
Charles Kerr
35a512310a Merge branch 'master' into add-env-to-release-docs 2018-03-07 16:38:14 +09:00
Charles Kerr
3b2a494033 Update to master. 2018-03-07 16:32:36 +09:00
Charles Kerr
b0820e4886
Fix broken link 2018-03-07 16:18:47 +09:00
Charles Kerr
4ab7b2d2b1 Deprecations come >=1 major release before removal 2018-03-07 16:12:28 +09:00
Shelley Vohr
c31bf8474c clean planned breaking changes for 3.0 (#12145) 2018-03-07 16:06:33 +09:00