Commit graph

2043 commits

Author SHA1 Message Date
Kevin Sawicki
eb6d92d427 Mention image cannot be empty on macOS 2017-01-26 15:46:04 -08:00
Kevin Sawicki
90470617ab Merge pull request #8430 from ramya-rao-a/crash-for-children-docs
Updated docs for crash reporter to support child processes
2017-01-24 14:08:36 -08:00
Kevin Sawicki
ce6a46ee59 Use template strings 2017-01-24 14:08:10 -08:00
Kevin Sawicki
108a3473ed Use crashesDirectory in example 2017-01-24 14:07:00 -08:00
Kevin Sawicki
4985e073c4 Mention how to test 2017-01-24 14:04:56 -08:00
Kevin Sawicki
7b03c05b4e Capitalize Electron, fence as JS 2017-01-24 14:03:54 -08:00
leethomas
fb741285c6 update documentation 2017-01-23 23:42:38 -08:00
Javan Makhmali
68eaf1fb9f Remove note in "did-fail-load" about redirect responses
ERR_ABORTED is suppressed now (https://github.com/electron/electron/pull/6201)
2017-01-22 16:39:42 -05:00
Ramya Achutha Rao
dc5129f32e Updated docs for crash reporter to support child processes 2017-01-17 21:59:23 -08:00
Zeke Sikelianos
ade16a7823 Merge pull request #8365 from destan/patch-3
printToPDF: `landscape` ignored if `@page` is used
2017-01-17 13:50:37 -08:00
Kevin Sawicki
13acf7a6a3 Mention accessing context in dev tools 2017-01-16 12:38:16 -08:00
Kevin Sawicki
dacfb2f596 Mention contextIsolation is experimental 2017-01-16 12:38:16 -08:00
Kevin Sawicki
572fc058d3 Document contextIsolation option 2017-01-16 12:38:16 -08:00
Kevin Sawicki
4ebe54043a Merge pull request #8395 from Arcath/patch-1
Add Squirrel Release Server to the update server list.
2017-01-16 11:41:43 -08:00
Kevin Sawicki
315daf1a10 Switch to footer link syntax 2017-01-12 16:54:07 -08:00
Adam Laycock
9e89ec041e Add Squirrel Release Server to the update server list. 2017-01-12 13:40:14 +00:00
Kevin Sawicki
ed4f4b3954 Rename autoSubmit to uploadToServer in example 2017-01-10 16:07:10 -08:00
Destan Sarpkaya
fb35f06114 printToPDF: landscape ignored if @page is used
This is very frustrating to find out via debugging, I think it should be in docs.
2017-01-09 02:31:34 +02:00
Kevin Sawicki
d200cf2e77 Document normalizeAccessKeys option 2017-01-06 08:56:24 -08:00
Kevin Sawicki
afa3bd2143 Put optional label before dash 2016-12-29 14:11:26 -08:00
Kevin Sawicki
f8d41f1f68 Link to offscreen rendering tutorial 2016-12-29 09:15:28 -08:00
Kevin Sawicki
5d505f9139 Support cursive/fantasy default font families 2016-12-28 13:40:53 -08:00
Zeke Sikelianos
c75a1f08fd replace all web-view code with webview 2016-12-22 10:41:05 -08:00
Zeke Sikelianos
1085c28612 rename all web-view files to webview 2016-12-22 10:41:05 -08:00
Drew Chandler
b28a865436 Use localstorage in clearStorageData docs
It won't work if you use include the space that is currently in the docs.
2016-12-22 09:51:39 -08:00
Kevin Sawicki
ad2627b05a Move variables from development to production 2016-12-22 09:22:04 -08:00
Cesar Andreu
e296d4826f Fix a typo, there => their 2016-12-21 19:21:04 -08:00
Zeke Sikelianos
e57cb713b2 link process annotations to glossary 2016-12-21 13:47:40 -08:00
Kevin Sawicki
f99dabbac6 Merge pull request #8078 from electron/dts-docs-update-again
Update Docs
2016-12-21 13:39:53 -08:00
Kevin Sawicki
b9f569f7fb Merge pull request #8248 from electron/secure-options
Add options to protocol.registerStandardSchemes docs
2016-12-21 09:40:30 -08:00
mawie81
d20e2ec349 [ci skip] fix link in screen docs 2016-12-21 09:43:47 +01:00
Kevin Sawicki
c5097ae483 Add options to protocol.registerStandardSchemes docs 2016-12-20 09:44:58 -08:00
Kevin Sawicki
5bb196dce3 Merge pull request #8240 from electron/fix-structures-link
fix relative link to CertificatePrincipal doc
2016-12-20 09:13:01 -08:00
Dustin
2e1feb63e4 Corrected some grammatical errors 2016-12-19 19:01:35 -08:00
Zeke Sikelianos
9e626c5fee fix relative link to CertificatePrincipal doc 2016-12-19 13:49:02 -08:00
Kevin Sawicki
6352afb07a Link to return class type 2016-12-19 09:40:07 -08:00
Kevin Sawicki
2a8b36c761 Merge pull request #8134 from deepak1556/empty_client_certificate_patch
app: select-client-certificate event callback can accept certificate optionally
2016-12-15 08:31:12 -08:00
Kevin Sawicki
cd067bca37 Merge pull request #8175 from gerhardberger/createfrombuffer-bitmap
Add bitmap support to nativeImage.createFromBuffer
2016-12-14 13:24:45 -08:00
Kevin Sawicki
98d4e186e3 Move details next to params 2016-12-14 10:19:38 -08:00
Kevin Sawicki
3b259b4243 Add createFromBuffer to planned breaking changes 2016-12-14 10:12:37 -08:00
Kevin Sawicki
88dac36c91 Move footer link to bottom 2016-12-13 15:58:03 -08:00
Birunthan Mohanathas
a3b65ad481 Add before-input-event event for webContents (fixes #7586)
Embedding arbitrary web content is problematic when it comes to keyboard
shortcuts because:

* Web content can steal app shortcuts (see e.g. brave/browser-laptop#4408)

* Blocked web content (e.g. a focused <webview> performing expensive
computation) will also prevent app shortcuts from firing immediately

The new before-input-event event can be used to overcome these issues by
always handle certain keyboard events in the main process.

Note that this requires electron/brightray#261 to compile.
2016-12-13 15:54:13 -08:00
gellert
7ceb8d1ab8 additional tests for createFromBuffer 2016-12-14 00:18:24 +01:00
gellert
a609e52a14 moves bitmap parameters to options object 2016-12-13 21:32:17 +01:00
gellert
39875c90f1 adds bitmap support to createFromBuffer 2016-12-13 21:32:17 +01:00
Linda_pp
704433f3d6 Fix broken link in dialog.md [ci skip] 2016-12-13 17:48:49 +09:00
Kevin Sawicki
2fa9ca1f6d Merge pull request #8156 from sindresorhus/remove-dock-window-level
🍎 Document that the `dock` window level is deprecated
2016-12-12 09:39:08 -08:00
deepak1556
975d677f55 add docs 2016-12-09 09:56:16 -08:00
deepak1556
d944219b28 add docs 2016-12-09 09:37:46 -08:00
Sindre Sorhus
3dde669ee8 🍎 Remove deprecated dock window level
According to the Apple docs, the `NSDockWindowLevel` constant is deprecated: https://developer.apple.com/reference/appkit/nsdockwindowlevel?language=objc
2016-12-09 12:46:49 +01:00
Kevin Sawicki
54d27a390b Merge pull request #8155 from salomvary/explain-macos-modal-sheet
Clarify modal windows being sheets on macOS
2016-12-07 10:29:42 -08:00
Kevin Sawicki
ba44dca34a Merge pull request #8158 from jdfwarrior/master
Add detail for the browserWindow argument in dialog docs
2016-12-07 10:28:34 -08:00
deepak1556
06701786c4 update docs 2016-12-07 13:26:06 +05:30
David Ferguson
32ae3a52b8 add detail for the browserWindow argument in dialog docs 2016-12-06 22:23:14 -06:00
Kevin Sawicki
e198b6945c Add simple postData example 2016-12-06 16:49:22 -08:00
Márton Salomváry
9adb232d99 Clarify modal windows being sheets on macOS 2016-12-06 22:47:26 +01:00
Kevin Sawicki
de0ec9b33c Tweak cancelId docs 2016-12-02 13:40:31 -08:00
Kevin Sawicki
2c8ab72269 Merge pull request #8084 from poiru/systempreferences-setuserdefault
Add systemPreferences.setUserDefault for macOS
2016-11-29 14:07:35 -08:00
Birunthan Mohanathas
486b6b9096 Add systemPreferences.setUserDefault for macOS
This API can be used to e.g. enable key repeat by setting
`ApplePressAndHoldEnabled` to `false` (see also #47).
2016-11-29 09:46:32 -08:00
Birunthan Mohanathas
18c49285a8 Add BrowserWindow.setAutoHideCursor for macOS
The `disableAutoHideCursor` BrowserWindow option can be used to control
auto-hiding behavior when the window is created. This new API is needed
to dynamically change the behavior after the fact.
2016-11-29 09:46:00 -08:00
Kevin Sawicki
4aa2b093ff Merge pull request #8072 from ramya-rao-a/doc-update
Clarifying crash reporter behviour in Mac
2016-11-28 15:37:21 -08:00
Kevin Sawicki
446065b88c Minor updates to crash reporter notes 2016-11-28 15:37:06 -08:00
Kevin Sawicki
0c73140b07 used -> called 2016-11-28 15:08:28 -08:00
Kevin Sawicki
02cbd24165 Mention setUploadToServer only has effect after start 2016-11-28 15:08:28 -08:00
Samuel Attard
2bf6f28152 shouldUpload --> uploadToServer 2016-11-28 15:08:28 -08:00
Samuel Attard
285a36f9de Use GetUploadsEnabled to return GetShouldUpload 2016-11-28 15:08:28 -08:00
Samuel Attard
0b9530efd7 shouldUpload API's are macOS only 2016-11-28 15:08:12 -08:00
Samuel Attard
6bbd92368f Add docs for getShouldUpload 2016-11-28 15:08:12 -08:00
Samuel Attard
7b8eb3e09c Rename autoUpload to shouldUpload 2016-11-28 15:08:12 -08:00
Kevin Sawicki
774b2f99f2 Merge pull request #8038 from electron/danhp/close-file-preview
Add 'win.closeFilePreview()'
2016-11-28 14:47:06 -08:00
Kevin Sawicki
a7395118af Merge pull request #7952 from the-ress/window-setappid
Added BrowserWindow.setAppDetails to set user model id, icon and relaunch command
2016-11-28 14:46:14 -08:00
Kevin Sawicki
5abecadfd3 Tweak setAppDetails docs 2016-11-28 14:29:21 -08:00
Daniel Pham
d5a0dd39a1 🎁 Add 'win.closeFilePreview()' 2016-11-28 14:25:11 -08:00
Samuel Attard
4ff7cf2bcc Update web-frame docs 2016-11-25 23:33:31 +11:00
Samuel Attard
f6a6ca8a22 Update cookies docs 2016-11-25 23:27:11 +11:00
Samuel Attard
c9615a201c Update app docs 2016-11-25 23:23:45 +11:00
Samuel Attard
921b474919 Fixup app and bw docs 2016-11-25 23:21:25 +11:00
Samuel Attard
06960704c4 Update docs for dts again 2016-11-25 23:17:31 +11:00
Ramya Achutha Rao
f8b738e6c2 Clarifying crash reporter behviour in Mac 2016-11-23 15:36:03 -08:00
Kevin Sawicki
cd5bfbfead Sort by codes 2016-11-23 09:10:27 -08:00
DanTheMan827
f89a045605 Fixed language code to Aragonese 2016-11-23 09:21:27 -06:00
Zeke Sikelianos
6b34b97c29 Merge pull request #8057 from electron/fixup-docs-for-ts
Docs update
2016-11-22 19:18:37 -08:00
Samuel Attard
6a8ee19bf0
Docs update 2016-11-23 11:51:44 +11:00
Kevin Sawicki
cf690ae513 Merge pull request #7986 from salomvary/fix-before-quit-docs
Clarify docs on a `before-quit` behavior edge case
2016-11-22 16:51:26 -08:00
Zeke Sikelianos
5dc4b22d31 Merge pull request #7992 from electron/process-doc-followup
Process doc followup
2016-11-22 10:46:57 -08:00
Kevin Sawicki
95ab4815de Merge pull request #8041 from electron/webview-zoom-factor
Add new method to set layout-based zoom level limit
2016-11-22 09:08:00 -08:00
Kevin Sawicki
9a5df9da41 Expose setVisualZoomLevelLimits on webContents and <web-view> 2016-11-22 08:07:55 -08:00
Kevin Sawicki
756a338b05 Document webFrame.setVisualZoomLevelLimits as public 2016-11-22 08:03:04 -08:00
Kevin Sawicki
fb5bca8bc5 Merge pull request #8046 from electron/bengotow/url-schemes-docs-patch
Update open-url docs to mention NSPrincipalClass
2016-11-22 07:50:13 -08:00
Kevin Sawicki
0d317a2e49 Add backticks around Info.plist 2016-11-22 07:49:56 -08:00
Ben Gotow
964c88a189 Update open-url docs to mention NSPrincipalClass
We got bit by a nasty bug today - if you change your app's info.plist `NSPrincipalClass` to something other to `AtomApplication` (We set it to NylasApplication via a bad find-replace), everything works except open-url is never fired. Add a small reference to the docs so folks know to check this key.
2016-11-21 16:55:18 -08:00
Kevin Sawicki
62b39d58ca crash-reporter -> crashReporter 2016-11-21 15:42:24 -08:00
Paul Betts
3e85d7759b 📝 2016-11-21 15:16:13 -05:00
Kevin Sawicki
ea6b53578f Mention preferred size 2016-11-21 08:45:46 -08:00
Kevin Sawicki
7916981da2 zoomToContentSize -> zoomToPageWidth 2016-11-21 08:45:46 -08:00
Kevin Sawicki
7896ee23a2 Document zoomToContentSize 2016-11-21 08:45:46 -08:00
muryoimpl
eab5376c25 Fix typo 2016-11-21 00:49:11 +09:00
Tereza Tomcova
b305020c1d Added documentation for BrowserWindow.setAppDetails 2016-11-18 21:43:03 +01:00
Zeke Sikelianos
d6e3360aef Merge pull request #8009 from deed02392/master
Update docs
2016-11-18 08:33:24 -08:00
George Hafiz
aac31159b8 Update formatting to prevent '[] ()' sequences (e.g. String[] (optional)), which breaks MD rendering on GitHub and hides the array indication 2016-11-18 00:34:48 +00:00
Kevin Sawicki
88809b0e0b Document reload and toggledevtools roles 2016-11-17 10:57:20 -08:00
Gabriel Handford
9382d48708 Update docs 2016-11-17 10:33:24 +09:00
Gabriel Handford
21df08d536 Remove redundant comment 2016-11-17 10:33:23 +09:00
Gabriel Handford
c78567aba6 Update shell openExternal docs (from review) 2016-11-17 10:33:23 +09:00
Gabriel Handford
b266533dfc Shell openExternal can take optional callback (macOS) 2016-11-17 10:33:23 +09:00
Zeke Sikelianos
468d8b7707 reference node's process object 2016-11-16 09:54:29 -08:00
Zeke Sikelianos
1da97f729e process object is available in renderer processes too 2016-11-16 09:54:19 -08:00
Zeke Sikelianos
a7fdd04751 move menu constructor docs to top of file 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
5979dab13c fix some class headings 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
c9739abf7f add description and process for BrowserWindow class 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
39330affda DownloadItem only needs one heading 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
d6684c4dcd fix UploadBlob heading 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
4770d2b526 returns an instance, not the module 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
2b689a21e7 fix structure headings 2016-11-16 09:02:49 -08:00
Zeke Sikelianos
b084dc29ea move each API doc into its own file 2016-11-16 09:02:49 -08:00
Márton Salomváry
98e18a62e2 Clarify docs on a before-quit behavior edge case
See #7875
2016-11-16 10:38:57 +01:00
Greg Nolle
5d028f9163 Expose extra certificate information: full breakdown of issuer and subject principals, as well as full structure of intermediate issuer certificates. 2016-11-15 15:53:42 -08:00
Greg Nolle
446399c3c1 Expose whole certificate chain to verify proc and certificate-error event. 2016-11-15 15:53:42 -08:00
Kevin Sawicki
0ef6d4631d Merge pull request #7658 from figma/webview-manual-guest-resize
Allow webview guests to be resized manually
2016-11-15 14:21:56 -08:00
Kevin Sawicki
35e000024c Minor doc updates to setSize/disableguestresize 2016-11-15 13:59:01 -08:00
Alexandre
6f8eb282b7 [ci skip] Correct Linux limitation example 2016-11-15 21:53:54 +01:00
Birunthan Mohanathas
2986b7bc4a Allow webview guests to be resized manually
This adds the `disableguestresize` property for webviews to prevent the
webview guest from reacting to size changes of the webview element. This
also partially documents the `webContents.setSize` function in order to
manually control the webview guest size.

These two features can be combined to improve resize performance for
e.g. webviews that span the entire window. This greatly reduces the lag
described in #6905.
2016-11-15 11:00:09 -08:00
Ben Randall
c259b4294d Update electron-squirrel-startup link
The currently link points to a non-existent page.  I'm pointing it to another link that seems to be appropriate, but I'm not positive.
If someone else knows that this is the correct place to link that would be nice to hear.
2016-11-14 10:16:24 -08:00
Kevin Sawicki
b9e950f5c7 Mark postData as optional 2016-11-12 07:15:21 +05:30
deepak1556
61576c39be uploadData => uploadRawData 2016-11-11 10:54:01 -08:00
deepak1556
723a3eda8b update docs 2016-11-11 10:54:01 -08:00
deepak1556
dbe57c4ad4 update docs 2016-11-11 10:54:01 -08:00
deepak1556
2044208fd6 add docs 2016-11-11 10:53:36 -08:00
Kevin Sawicki
4de2493d89 Move footer links to bottom 2016-11-11 10:22:27 -08:00
Zeke Sikelianos
ec7cae4a34 add process to contentTracing doc 2016-11-11 10:07:36 -08:00
Samuel Attard
174e51507d Update menu.md 2016-11-11 09:22:55 -08:00
Samuel Attard
494afec01d remote require could resolve to strings/numbers not just objects 2016-11-11 09:22:55 -08:00
Samuel Attard
aeefee7348 Fix the download-item doc so it correctly resembles a class 2016-11-11 09:22:55 -08:00
Samuel Attard
c1af62a3b3 Move crash-report object to it's own struct 2016-11-11 09:22:55 -08:00
Samuel Attard
11f8923c43 Fix tray and menu docs 2016-11-11 09:22:55 -08:00
Samuel Attard
63ebc41778 More docs updates 2016-11-11 09:22:55 -08:00
Samuel Attard
1a9b4b4671 First few docs made optional 2016-11-11 09:22:55 -08:00
gellert
2cf30c0d63 remove method transferred to set with null 2016-11-11 08:49:57 -08:00
gellert
16253fe708 doc fixes 2016-11-11 08:49:57 -08:00
gellert
84a3fe50dc little fix in docs 2016-11-11 08:49:57 -08:00
gellert
8ad50d1e35 adds vibrancy effect for macos 2016-11-11 08:49:57 -08:00
joshaber
999b349e94 Docit 2016-11-10 13:35:56 -05:00
Zeke Sikelianos
ef9d8fe9bd Merge pull request #7843 from electron/process-docs
document the process(es) in which APIs are available
2016-11-03 13:14:30 -07:00
Zeke Sikelianos
471b9980ec line up process annotations consistently 2016-11-03 13:13:21 -07:00
Zeke Sikelianos
21105271a4 document processes for APIs nested in parent docs 2016-11-03 11:50:00 -07:00
Zeke Sikelianos
ac68de6215 document process(es) for all APIs 2016-11-03 10:26:00 -07:00
Samuel Attard
9f18a6e65c Use ES6 template strings, fix docs and remove _ERROR_ IPC event 2016-11-03 09:33:47 -07:00
Samuel Attard
857e1da6a3 Make executeJavaScript return a Promise so that caught errors can be sent to the caller 2016-11-03 09:33:47 -07:00
Zeke Sikelianos
cc18670ae1 Merge pull request #7854 from electron/fix-ipc-docs
Fix the IPC docs so the docs-linter finds the methods
2016-11-02 20:14:47 -07:00
Samuel Attard
6228ce3f35
Fix the IPC docs so the docs-linter finds the methods 2016-11-03 14:04:03 +11:00