Commit graph

1290 commits

Author SHA1 Message Date
Kevin Sawicki
b1c0e7e2ab web-frame -> webFrame 2016-04-26 10:28:04 -07:00
Cheng Zhao
b5d2e51100 docs: platform-theme-changed is deprecated 2016-04-25 22:27:44 +09:00
Cheng Zhao
11653aa9c8 docs: systemPreferences 2016-04-25 15:36:38 +09:00
Cheng Zhao
096b948570 Merge pull request #5249 from electron/api-summaries
create a one-liner description for each API
2016-04-24 13:50:17 +09:00
Cheng Zhao
2f06a2af81 Merge pull request #5252 from miniak/doc-fix
Documentation fixes
2016-04-24 13:37:45 +09:00
Milan Burda
dfd1a46956 Document process.crash method 2016-04-22 23:58:41 +02:00
Zeke Sikelianos
799fd13c50 more updates to api summaries based on feedback 2016-04-22 11:42:54 -07:00
Zeke Sikelianos
2c8261b429 update excerpts based on feedback 2016-04-22 10:32:28 -07:00
Zeke Sikelianos
0527b17e42 blockquote summaries 2016-04-22 10:32:28 -07:00
Zeke Sikelianos
ee190ca62a create a one-liner description for each API 2016-04-22 10:32:28 -07:00
Plusb Preco
6205dfa25f 📝 Remove additional whitespaces
[ci skip]
2016-04-22 23:30:41 +09:00
Plusb Preco
a14014941b 📝 Fix coding style issues
[ci skip]
2016-04-22 23:26:19 +09:00
Plusb Preco
66f4701d93 📝 Remove additional whitespaces
[ci skip]
2016-04-22 23:23:15 +09:00
Plusb Preco
b6f8dcea20 📝 Add missing platform specified tag
[ci skip]
2016-04-22 23:21:42 +09:00
Plusb Preco
7fa4b7c8b5 📝 Normalize code tags
[ci skip]
2016-04-22 23:15:31 +09:00
Plusb Preco
cbc2a869e3 📝 Fix typos
[ci skip]
2016-04-22 22:56:24 +09:00
Plusb Preco
4f4277e25e 📝 Fix coding style issues
* Adjust line length to `80`
* Normalize whitespaces

[ci skip]
2016-04-22 22:54:43 +09:00
Plusb Preco
0282180b9c 📝 Correct description style
[ci skip]
2016-04-22 22:20:41 +09:00
Milan Burda
da727a3c1b Fix display.rotation documentation 2016-04-22 12:32:11 +02:00
Felix Rieseberg
c0f63eed4e 🎨 Windows Store Camels 2016-04-21 19:11:25 -07:00
Daniel Pereira
b45f683655 Update desktop-capturer.md
Fixed native image link.
2016-04-21 17:00:19 -05:00
Cheng Zhao
c92e622ce0 Merge pull request #5238 from electron/felix/appx-detection
Add Windows Store Detection
2016-04-21 16:21:38 +09:00
Felix Rieseberg
2a2a8d3263 Add Windows Store Detection
If we're running as a Windows Store appx package,
`process.windowsstore` will be `true`, otherwise
`undefined`.
2016-04-21 00:02:03 -07:00
deepak1556
ca756c3c24 session: allow providing permission to handle external protocols 2016-04-21 05:27:07 +05:30
Cheng Zhao
aa29dc0c8a Merge pull request #5199 from Mr0grog/5183-disambiguate-loading-from-main-frame-loading
Add `isLoadingMainFrame()` to WebContents
2016-04-20 20:49:56 +09:00
Rob Brackett
dc8fc7c079 📝 Add English docs for webContents.isLoadingMainFrame()
[ci skip]
2016-04-19 23:27:22 -07:00
Cheng Zhao
823c4f91a8 Merge pull request #5219 from atdrago/master
Add note for OS X about using `role` on MenuItem
2016-04-20 15:11:43 +09:00
Cheng Zhao
965c3f605e Merge pull request #5197 from deepak1556/client_certificate_patch
app: api to import client certificate
2016-04-20 14:35:00 +09:00
Cheng Zhao
d7a391dc61 Merge pull request #5214 from alexgleason/docs-downloaditem-typo
Fixed docs sample code programming error for DownloadItem
2016-04-20 13:44:31 +09:00
Cheng Zhao
d3bff7fffc Merge pull request #5208 from deepak1556/devtools_dock_state_patch
devtools: allow opening in specified dock state
2016-04-20 13:34:52 +09:00
deepak1556
794d120754 rename importClientCertificate => importCertificate 2016-04-20 08:45:49 +05:30
Adam Drago
b80272dbb4 Add note for OS X about using role on MenuItem 2016-04-19 18:12:37 -07:00
Cheng Zhao
18f5fcde60 Fix some coding style issues 2016-04-20 09:18:50 +09:00
Cheng Zhao
eb9e0e5534 Merge pull request #4922 from electron/bengotow/sheet-offset
Allow sheets to be attached at a custom offset #4679
2016-04-20 08:55:42 +09:00
Cheng Zhao
873e9c44db Merge pull request #5196 from raybooysen/patch-1
Update screen.md
2016-04-20 08:44:41 +09:00
Jessica Lord
5e9fe1c6eb Merge pull request #5168 from electron/jlord-patch-1
A few style updates 2 docs
2016-04-19 12:29:42 -07:00
Alex Gleason
02c8c58c0b Fixed docs sample code programming error for DownloadItem 2016-04-19 12:47:05 -04:00
deepak1556
58dfad4d01 devtools: allow opening in specified dock state 2016-04-19 18:12:05 +05:30
Ben Gotow
8f89cd2d59 Move "setSheetOffset" to the BrowserWindow 2016-04-18 22:39:12 -07:00
Jessica Lord
c3200ba7f6 Revert "Fix headers"
This reverts commit 4dd2716865.
2016-04-18 18:00:32 -07:00
Cheng Zhao
5c75fbe369 Merge pull request #5192 from andrewda/patch-1
Update link to setFeatureEnabledFromString
2016-04-19 08:59:15 +09:00
deepak1556
919be67cd2 remove --client-certificate flag 2016-04-18 22:26:37 +05:30
Ray Booysen
5a9b86dd05 Update screen.md 2016-04-18 17:04:47 +01:00
Andrew Dassonville
12483486c0 Update link to setFeatureEnabledFromString 2016-04-17 23:04:02 -07:00
Milan Burda
d512421084 Fix documentation 2016-04-16 19:58:03 +02:00
Ben Gotow
c87c49f4c8 Allow sheets to be attached at a custom offset #4679
Adds a new "setSheetOffset" API to the `dialog` module, which allows you to change the attachment point for sheets on Mac OS X. I put the API on the dialog module, even though Mac OS X requires that the native window hold and return the desired offset.

1. I was originally hoping to make this an argument on the actual dialog.show* calls, but it seems the parameter set is defined in `libchromiumcontent` and I wasn't sure it would be appropriate to add there?

2.  The API could also be on the BrowserWindow (eg `BrowserWindow.setSheetOffset`). I don't have a strong preference, but I think it's more discoverable on the `dialog` module.
2016-04-16 10:16:43 -04:00
Cheng Zhao
44bc24174c Merge pull request #5159 from djpereira/patch-1
Sample missing reference to webContents for toggleDevTools
2016-04-15 19:59:50 +09:00
Jessica Lord
4dd2716865 Fix headers 2016-04-14 20:55:43 -07:00
Jessica Lord
7d96f3d720 Add new line
so that the list is styled correctly on website
2016-04-14 15:53:34 -07:00
Daniel Pereira
7b56085a0a Update menu.md
There was a missing reference to webContents.
2016-04-14 10:50:08 -05:00
christoth
4708477f5a webview: add CSS styling notes
Create a new section for CSS and add notes to avoid hiding the webview via hidden or display:none; and provide a recommended approach.
2016-04-14 10:29:55 -04:00
Cheng Zhao
a07612c1ed Merge branch '5074-did-get-response-details-resource-type' of https://github.com/Mr0grog/electron into Mr0grog-5074-did-get-response-details-resource-type 2016-04-11 21:05:40 +09:00
Cheng Zhao
5659ee5c0b Merge pull request #5030 from deepak1556/webrequest_response_headers_patch
session: webRequest.OnHeadersReceived should accept status line.
2016-04-11 20:04:32 +09:00
Rob Brackett
50f51899de Document resourceType arg for did-get-response-details event. 2016-04-08 13:03:22 -07:00
deepak1556
3fb39ad3ef provide option to override status line 2016-04-08 14:03:57 +05:30
Cheng Zhao
5ff97317fe Merge pull request #5086 from electron/no-throttling
Add backgroundThrottling option to webPreferences
2016-04-08 16:25:09 +09:00
Cheng Zhao
d169ebf737 Merge pull request #5070 from christoth/master
webview: Update doc to reflect use of flexbox layout
2016-04-08 16:09:12 +09:00
Cheng Zhao
d156846036 Add backgroundThrottling option to webPreferences 2016-04-08 15:54:33 +09:00
Kevin Sawicki
59991f2fd8 Mention codesigning is required on OS X 2016-04-07 09:03:31 -07:00
christoth
a79c63581d Update doc to reflect use of flexbox layout
Updated documentation, changed `display:inline-block` to `display:inline-flex', explicitly noted the use of the new layout and how it can be broken by overwriting the CSS `display' property.
2016-04-07 10:42:42 -04:00
Cheng Zhao
82856eb099 Merge pull request #5029 from Mr0grog/5013-add-main-frame-param-for-did-fail-load
Add `isMainFrame` param to WebContents `did-fail-load` event
2016-04-07 20:22:02 +09:00
Cheng Zhao
aae83cbce8 Merge pull request #4986 from Aluxian/Aluxian-patch-1
Add squirrel-updates-server link in the docs
2016-04-07 16:11:49 +09:00
Rob Brackett
884c9cc2f5 Document isMainFrame argument for WebContents did-fail-load event. 2016-04-04 19:36:34 -07:00
Kevin Sawicki
102f7e8e33 Update docs for new org 2016-04-04 12:05:53 -07:00
Cheng Zhao
442ccbe204 Merge pull request #4997 from atom/default-app-background-color
Set backgroundColor for the default app
2016-04-03 14:07:39 +09:00
Cheng Zhao
a9ea8b92f0 Merge pull request #4988 from atom/accelerator-docs
use example accelerators that align with best practices
2016-04-03 14:03:32 +09:00
Cheng Zhao
eb82f7cea9 Update docs for backgroundColor 2016-04-03 13:55:33 +09:00
Cheng Zhao
70ca49e36a Merge pull request #4989 from atom/document-option-vs-alt
use alt, not option
2016-04-02 19:19:09 +09:00
Kevin Sawicki
55b12c184b Doc node integration inheritance 2016-04-01 16:48:21 -07:00
Zeke Sikelianos
2853356b10 use alt, not option 2016-04-01 15:48:12 -07:00
Zeke Sikelianos
b92e86301a use cross-platform accelerator in globalShorcut documentation 2016-04-01 14:54:25 -07:00
Zeke Sikelianos
ac419038c6 use example accelerators that align with best practices 2016-04-01 14:09:01 -07:00
Alexandru Rosianu
ff7bb1e6cb Add squirrel-updates-server link in the docs
Add link to Aluxian/squirrel-updates-server in the docs page for autoUpdater
2016-04-01 14:28:52 +03:00
Kevin Sawicki
1eddaecef8 Merge pull request #4964 from jwheare/app-command-docs
Improve app-command docs, list arguments and explain command string
2016-03-31 15:45:16 -07:00
Kevin Sawicki
389b2b5cdd Merge pull request #4963 from preco21/document-fixes-2
Docs: Improve docs styles
2016-03-31 15:44:31 -07:00
Kevin Sawicki
f87e417f7f Merge pull request #4962 from erkyrath/doc-issue-4884
Added information about the enabled, visible, and checked properties
2016-03-31 15:43:22 -07:00
Kevin Sawicki
9e2dd13f9a Merge pull request #4959 from atom/check-url-before-opening
Only open http/https links in new-window example
2016-03-31 15:41:33 -07:00
Felix Rieseberg
ae5a6e61c5 📝 Add "remote" note to dialog docs
Ref #4943
2016-03-31 09:54:01 -07:00
Cheng Zhao
e23faceba0 docs: Add notes on app.getLocale 2016-03-31 17:22:09 +09:00
James Wheare
d4a14bc215 Improve app-command docs, list arguments and explain command string 2016-03-31 08:56:49 +01:00
Plusb Preco
546ad643e4 📝 Add missing docs
[ci skip]
2016-03-31 14:30:14 +09:00
Plusb Preco
a648528f43 📝 Normailze note markers
* Normalize note markers syntax `__` to `**`

[ci skip]
2016-03-31 14:22:28 +09:00
Plusb Preco
346ef9df0c 📝 Update docs styles
* Adjust line length to `80`
* Normalize whitespaces

[ci skip]
2016-03-31 14:16:14 +09:00
Andrew Plotkin
cfd2cdb9c4 Added information about the enabled, visible, and checked properties --
when they can be set and what they mean.

Also tidied up the grammar and clarified wording.
2016-03-30 23:57:28 -04:00
Cheng Zhao
be5e787edf Merge pull request #4885 from ArekSredzki/patch-1
Added electron-release-server link to the docs
2016-03-31 11:07:14 +09:00
Cheng Zhao
c220753c60 Merge pull request #4896 from felixrieseberg/default-protocol-handler
Enable Electron to set/unset itself as default protocol handler (OS X, Windows)
2016-03-31 10:38:57 +09:00
Cheng Zhao
0e3737423b Merge pull request #4843 from jwheare/mac-swipe-events
OSX: Expose 3-finger swipe events in browser-window
2016-03-31 10:37:27 +09:00
Kevin Sawicki
dd23b09569 Only open http/https links 2016-03-30 16:55:10 -07:00
Plusb Preco
c4a2329665 📝 Update docs styles
* Adjust line length to `80`
* Change platform marker `*` to `_`
* Enhance a note section

[ci skip]
2016-03-30 10:57:42 +09:00
Felix Rieseberg
1231360b2f Add API: RemoveAsDefaultProtocolHandler 2016-03-28 15:31:01 -07:00
Alejandro Gonzalez Sole
ab685ac335 Update power-monitor.md
Updated docs in power-monitor to reflect windows only events
2016-03-27 23:03:34 -04:00
Kevin Sawicki
8feb0f0440 Put link on same line as name 2016-03-24 15:57:42 -07:00
Felix Rieseberg
d2567b0381 Add API: SetASDefaultProtocolHandler
This PR adds an API enabling Electron to set itself as the default
protocol handler for a custom porotocl on both oS X and Windows.

For details, please see `docs/app.md`.

Closes #4857
2016-03-23 22:12:17 -07:00
James Wheare
8482109dea Switch to a single OS X swipe event with a direction argument 2016-03-23 15:20:11 +00:00
Arek Sredzki
951bd745aa Added electron-release-server link to the docs
By request from a couple users, I've added a link to the electron-release-server, that makes using the auto-updater much easier.
2016-03-22 16:35:03 -07:00
Kevin Sawicki
baa566adae Merge pull request #4851 from k0kubun/app-doc-set-name
Document `app.setName()`
2016-03-22 09:35:49 -07:00
Takashi Kokubun
8cf4574198 Document app.setName()
[ci skip]
2016-03-22 11:01:23 +09:00
Milan Burda
f84c41f684 Fix Menu documentation 2016-03-20 19:05:18 +01:00
James Wheare
03319a5426 OSX: Capture 3-finger swipe events in NativeWindow 2016-03-18 15:21:19 +00:00
Cheng Zhao
cbd37ad3b9 docs: List breakpad server implementations 2016-03-17 22:29:32 +09:00
Cheng Zhao
912ec1437b Merge pull request #4812 from thanpolas/patch-1
More info for crash reporter form type and payload
2016-03-17 22:24:10 +09:00
Cheng Zhao
f8b9a66ead docs: Make it clear image.getNativeHandle is OS X only 2016-03-17 21:55:44 +09:00
Cheng Zhao
081ab17e13 Merge pull request #4791 from atom/nativeimage-as-nsimage
Convert NativeImage instances to OS-specific representations
2016-03-17 21:49:46 +09:00
Thanasis Polychronakis
492269a0fd More info for crash reporter form type and payload 2016-03-15 15:49:34 +02:00
Paul Betts
f59752bf4f Update the docs to match 2016-03-14 19:51:37 -07:00
Paul Betts
5dea4b9b1c Add documentation 2016-03-13 20:11:43 -07:00
Robo
8378cbb1e8 webcontents: provide position of match with found-in-page event 2016-03-14 06:49:45 +05:30
Cheng Zhao
03ec5ced05 Merge pull request #4751 from maxbeatty/window-blur
Add blur method to window
2016-03-11 19:15:51 +09:00
Max Beatty
704b8335aa Add blur method to window ref #4724 2016-03-10 21:45:51 -08:00
Arek Sredzki
c1267b2320 Added 'show' & 'hide' events to browser-window, fixed visibilitychange event in renderer 2016-03-10 13:51:31 -08:00
Plusb Preco
ebf509bbe4 📝 Adjust 80 chars per line
[ci skip]
2016-03-10 16:54:07 +09:00
Daniel Pham
0b8c2545b9 📝 Document 'app.focus()'
[ci skip]
2016-03-09 09:03:38 -05:00
Machisté N. Quintana
f47851f1e7 📝 🎨 Hard wrap 2016-03-07 16:19:00 -08:00
Machisté N. Quintana
eb064240f8 📝 Link to OS X Cocoa Event Handling guide on actions 2016-03-07 16:11:58 -08:00
Cheng Zhao
aa8dbbf6b6 Merge pull request #4695 from dongjoon-hyun/fix_link_name
Fix link name.
2016-03-07 10:31:49 +09:00
Cheng Zhao
0e2ac2d802 Merge pull request #4646 from phamdaniel/dark-mode
Add API to check OSX's Dark theme
2016-03-07 09:53:03 +09:00
Daniel Pham
68b453770b 🍎 Rename 'isDarkModeEnabled' to 'isDarkMode' 2016-03-06 10:55:47 -05:00
Dongjoon Hyun
f9f20957a4 Fix link name. 2016-03-05 23:28:39 -08:00
Cheng Zhao
b7a40f3097 docs: Add missing key codes 2016-03-06 15:12:04 +09:00
Cheng Zhao
f5d79677fa Merge branch 'will-fullscreen' of https://github.com/MaxWhere/electron 2016-03-05 21:30:41 +09:00
Daniel Pham
63294892f0 Rename dark-mode-changed to platform-theme-changed 2016-03-03 23:58:58 -05:00
Daniel Pham
c4049cb393 🍎 Add 'dark-mode-changed' event to app api 2016-03-01 15:43:38 -05:00
Daniel Pham
eaac67ac60 🍎 Add 'isDarkModeEnabled' to app api 2016-03-01 13:12:21 -05:00
Andrea Parodi
fd11b7e7db Removed duplicate isDevToolsFocused entry 2016-02-27 20:34:51 +01:00
Heilig Benedek
bb42c85df8 resolve update conflicts 2016-02-27 03:23:10 +01:00
Heilig Benedek
bb0ac688b2 Reverted SetFullscreenable disabling maximize button on Windows and removed that from the docs. 2016-02-27 03:07:53 +01:00
Cheng Zhao
ebfc127628 Merge pull request #4522 from deepak1556/async_execute_javascript_patch
webContents: provide responses for executeJavscript method
2016-02-26 21:17:47 +08:00
gellert
070772b4b9 Added special key identifiers for OSX and Windows 2016-02-26 20:22:46 +08:00
Robert Lyall
6f45678e9c Fix Menu template API example 2016-02-25 18:28:03 +00:00
Robo
a734326907 track async api requests 2016-02-25 11:45:59 +05:30
Robo
2b547bd44a webContents: provide responses for executeJavscript method 2016-02-25 11:45:59 +05:30
Robo
6fcc197db8 webview: api to get webcontents and associated host webcontents 2016-02-24 11:55:15 +05:30
Heilig Benedek
39bb670719 Revert will-enter-full-screen event, matching osx fullscreen: false behaviour on windows instead 2016-02-22 10:23:56 +01:00
Brad Metcalf
2a6fcf48e5 Changed session to app to reflect rest of document 2016-02-18 13:41:22 -06:00
Cheng Zhao
aa03a9d0ef Merge pull request #4534 from apoco/menu-documentation
Link to Menu documentation
2016-02-18 20:14:08 +08:00
Jacob Page
9c9759a683 Link to Menu documentation
Added link to documentation about `Menu` objects
2016-02-17 21:30:01 -08:00
Kevin Sawicki
42041cd402 Use markdown list for new options param 2016-02-17 08:56:59 -08:00
Ben Gotow
d8679b3899 Allow openExternal to open URLs in the background #3224 2016-02-17 08:56:58 -08:00
Cheng Zhao
0ba86b9716 docs: Make variable names follow previous example 2016-02-16 23:10:05 +08:00
Destan Sarpkaya
afacca252e add a new platform definition for linux
On Linux in order for changes made to individual `MenuItem`s to take effect, you have to call `setContextMenu` again

Regarding https://github.com/atom/electron/issues/1473
2016-02-16 16:24:05 +02:00
Cheng Zhao
e47a815c38 Merge pull request #4482 from lukeapage/patch-7
spelling fixes and americanisms
2016-02-16 20:22:31 +08:00
Cheng Zhao
25ac6f0f37 Merge pull request #4480 from apoco/single-instance-clarification
makeSingleInstance clarification
2016-02-16 20:17:18 +08:00
Cheng Zhao
55642d257d Merge pull request #4494 from pra85/patch-3
docs: fix a minor typo
2016-02-16 12:28:08 +08:00
Cheng Zhao
fded8d80b1 docs: Remove unnecessary "properties: " suffix 2016-02-16 12:11:05 +08:00
Cheng Zhao
2b406ccaf7 Optional => optional 2016-02-16 11:54:41 +08:00
Cheng Zhao
b8e8e4c930 docs: Cleanup the IPC docs 2016-02-16 11:34:39 +08:00
Cheng Zhao
d035fc2816 Merge pull request #4453 from lukeapage/patch-6
Docs - clarify ipc arguments
2016-02-16 11:08:35 +08:00
Prayag Verma
367a3524b9 docs: fix a minor typo
Remove extra `will`
2016-02-16 07:51:14 +05:30
Luke Page
a141d6b3d4 spelling fixes and americanisms 2016-02-15 06:51:20 +01:00
Luke Page
2c6e5d0464 Clarify arguments sent via ipc 2016-02-15 06:29:52 +01:00