Charles Kerr
57cda797f3
docs: copyediting of breaking-changes.md
...
Tweak the phrasing of sections' introductions
2018-05-29 11:42:20 +02:00
Charles Kerr
b0f1b5f65b
Modify 2.0 section's phrasing to use past tense
2018-05-29 11:37:42 +02:00
Charles Kerr
b621321ea0
Re-add missing section
2018-05-29 11:24:39 +02:00
Charles Kerr
066b92c7cd
docs: re-document the 2.0 breaking API changes
2018-05-29 11:23:28 +02:00
Charles Kerr
57ad506cde
Reorder the version sections newest-to-oldest
...
This puts 4.0 before 3.0, making room to re-add
the 2.0 changes back in at the end of the file.
2018-05-29 11:17:26 +02:00
Charles Kerr
7f64dbc1ba
Make FIXME and API Contract their own H1 sections
...
Previously they were inside the 3.0 section,
which doesn't really make sense
2018-05-29 11:15:30 +02:00
Charles Kerr
bb4979a82e
docs: move breaking-changes to api
2018-05-29 11:06:56 +02:00
Shelley Vohr
265aa3da29
docs: deprecate UploadFileSystem ( #13064 )
...
Deprecate UploadFileSystem in preparation for its being phased out completely in Chromium 66 and correspondingly Electron 4.0.0.
2018-05-25 10:50:27 -07:00
Ali BARIN
b0b31e67da
fix: Update broken dock link in app doc
2018-05-24 21:21:08 +02:00
Felix Rieseberg
f087f8e205
docs: Document missing quit events during shutdown ( #12986 )
...
* docs: Document missing events during shutdown
2018-05-18 07:27:44 -04:00
Shelley Vohr
83993fede8
update locale documentation ( #12967 )
2018-05-17 10:34:54 -07:00
Shelley Vohr
f068ed9ee7
fix docs formatting for ts defs ( #12968 )
2018-05-16 14:59:44 -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
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
Tim Fish
82329124ff
Fixes #12710 ( #12786 )
2018-05-02 12:19:52 -04: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
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
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
James Wheare
bf2b4814e0
[docs] app.isDefaultProtocolClient is available on Linux now ( #12674 )
2018-04-23 01:16:43 +10: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
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
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
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