Commit graph

307 commits

Author SHA1 Message Date
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
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
Samuel Attard
06960704c4 Update docs for dts again 2016-11-25 23:17:31 +11:00
Samuel Attard
6a8ee19bf0
Docs update 2016-11-23 11:51:44 +11:00
Kevin Sawicki
9a5df9da41 Expose setVisualZoomLevelLimits on webContents and <web-view> 2016-11-22 08:07:55 -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
Zeke Sikelianos
b084dc29ea move each API doc into its own file 2016-11-16 09:02:49 -08:00
Kevin Sawicki
35e000024c Minor doc updates to setSize/disableguestresize 2016-11-15 13:59:01 -08: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
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
dbe57c4ad4 update docs 2016-11-11 10:54:01 -08:00
deepak1556
2044208fd6 add docs 2016-11-11 10:53:36 -08:00
Samuel Attard
63ebc41778 More docs updates 2016-11-11 09:22:55 -08: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
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
tinydew4
fbe4394bbd Clean unnecessary sentences on web-contents.md 2016-10-26 15:41:47 +00:00
Samuel Attard
76da80c5e9
Further clean up 2016-10-26 16:18:55 +11:00
Kevin Sawicki
632739ec6e Merge pull request #7590 from electron/docs-cleanup
Cleanup docs and standardize structs
2016-10-24 15:13:39 +09:00
Kevin Sawicki
b2559d7d28 Merge pull request #7596 from electron/function-param-types
Function param types
2016-10-24 12:40:41 +09:00
Long Nhat Nguyen
c017a7a1c7 Update url (#7598)
* Update EventEmitter URL

* Update EventEmitter URL

* Enable click

* Update EventEmitter URL

* Update EventEmitter URL

* Update URL

* Update URL

* Update EventEmitter URL

* Tweak sentence and add perios
2016-10-13 14:09:14 -07:00
Samuel Attard
20323e7032
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00
Samuel Attard
78343a62b8
Cleanup docs and standardize structs 2016-10-13 14:38:06 +11:00
tinydew4
6b39e4a210 Apply the changes about #7379 to ko_KR 2016-10-13 00:34:39 +00:00
Samuel Attard
4d49156dac
Rename bounds -> rectangle 2016-10-08 13:09:31 +11:00
Samuel Attard
03979936f3 Move reused object structures to a standard structures folder 2016-10-06 11:59:42 -07:00
Michael Vasseur
22bd7c0271 Updated the related documentation 2016-10-05 09:47:38 +02:00
Cheng Zhao
c4576463e2 Format the docs according to style guide 2016-10-04 14:41:37 +09:00
Michael Vasseur
3af686daff Documented JavasScript API changes related to the fix for additional features processing 2016-10-04 14:38:32 +09:00
Joseph Frazier
5d1c626a53 Fix webContents.findInPage links in docs 2016-10-03 02:07:52 -04:00
Samuel Attard
e0e47ea9a1 Update docs to contain more specific return values 2016-09-28 18:28:44 +13:00
Samuel Attard
d2a701a465 Document the return values of all methods in the docs 2016-09-25 12:59:30 +13:00
Cheng Zhao
26004f1a66 Merge pull request #7241 from miniak/crashed-killed
Add killed argument for webContents.on("crashed") and app.on("gpu-process-crashed") events
2016-09-19 16:02:52 +09:00
Milan Burda
8567f79e67 Add killed argument for webContents.on("crashed") and app.on("gpu-process-crashed") events 2016-09-17 17:02:36 -07:00
gellert
8baaad4e0d cleanup and adds docs 2016-09-16 23:27:51 +02:00
deepak1556
e7f1265b64 add save-to-disk disposition for new-window event 2016-09-16 16:30:26 +05:30
Cheng Zhao
fbac635687 Only emit finalUpdate found-in-page events
Since Chrome 53 all meaningful results of found-in-page are finalUpdate.
2016-09-14 16:23:01 +09:00
roderik
1ff58a6066 documents webContents.fromId 2016-08-30 22:25:04 -05:00
Menci
ec60c149f5 Add guide for force new page in print / printToPDF 2016-08-30 08:45:39 +08:00
Zeke Sikelianos
5619558689 document some missing parameters 2016-08-25 14:43:06 -07:00
Zeke Sikelianos
0e4e60625f fix method heading level 2016-08-25 14:42:53 -07:00
Zeke Sikelianos
28d42ba35b document missing method parameters 2016-08-25 10:52:19 -07:00
Kevin Sawicki
1276587ebe Merge pull request #6934 from electron/add-missing-class-descriptions
Give every class a description
2016-08-23 10:16:29 -07:00
Zeke Sikelianos
3d371e09b7 add a blockquote for every class 2016-08-22 14:11:03 -07:00
Kevin Sawicki
e84d0ebb7e Merge pull request #6932 from electron/fix-power-save-blocker-doc-bug
Fix some invalid docs
2016-08-22 12:30:00 -07:00
Zeke Sikelianos
8c0a551d25 fix linting errors in docs 2016-08-22 11:47:55 -07:00
Zeke Sikelianos
d9901e62b6 improve doc for loadURL 2016-08-18 22:20:55 -07:00
Kevin Sawicki
09adffe48f Merge pull request #6870 from electron/more-permissive-standard-markdown
Use a more permissive version of standard-markdown
2016-08-17 08:52:06 -07:00
Cheng Zhao
47c37d6f51 Merge pull request #6814 from brave/net-converter-fix
don't convert a string to an array buffer
2016-08-17 20:44:13 +09:00
Zeke Sikelianos
cc2b95fac3 js → javascript 2016-08-16 14:50:21 -07:00
Zeke Sikelianos
e71280f31c restore js label to orphan code blocks 2016-08-16 14:49:42 -07:00
bridiver
94c60379d1 don't convert a string to an array buffer 2016-08-13 13:35:23 -07:00
Samuel Attard
0b624315b2
Fix attribute typo in docs 2016-08-12 01:49:56 +10:00
Samuel Attard
5b07e8dd5b
Send isMainFrame as argument to did-navigate-in-page event 2016-08-12 01:27:50 +10:00
Cheng Zhao
7173d8b01b Use getBitmap in docs 2016-08-05 18:08:36 +09:00
Cheng Zhao
736fbd46c6 docs: Show how to use bitmap data directly 2016-08-05 17:40:42 +09:00
Cheng Zhao
8c4ebdc88e Emit NativeImage objects in paint event 2016-08-05 17:40:42 +09:00
Cheng Zhao
64334fd40b Pass SkBitmap directly 2016-08-04 13:22:19 +09:00
Cheng Zhao
32d9382417 Merge pull request #6713 from MaxWhere/offscreen-rendering-fixes
Fixes buffer size in offscreen mode
2016-08-04 13:00:54 +09:00
Kevin Sawicki
05ab7d39ad Mark isDestroyed as public on BrowserWindow/WebContents 2016-08-03 14:58:22 -07:00
gellert
ca16132268 renames to bytesPerPixel and use nullptr 2016-08-03 19:39:23 +02:00
Milan Burda
d8f79bf29b docs: fix cwd description for shell.writeShortcutLink 2016-08-03 18:27:15 +02:00
gellert
50485a28d3 fixes buffer size and adds pixel size to paint event 2016-08-03 13:28:19 +02:00
Cheng Zhao
5dabc47440 Remove the view-painted event 2016-08-03 16:20:55 +09:00
Cheng Zhao
ba9aa13bd8 Fix lint warnings in documentations 2016-08-03 10:15:38 +09:00
gellert
8eed91d87a Merge remote-tracking branch 'upstream/master' into speedup-gpu 2016-08-02 14:59:03 +02:00
Cheng Zhao
84bb82866d docs: the callbacks 2016-08-02 14:44:06 +09:00
Samuel Attard
b59f37de98 Document the async versions of getZoomFactor and getZoomLevel 2016-08-02 13:04:21 +10:00
Samuel Attard
a1f5ca1ad2 Document the zoom methods that are mapped to the webContents object 2016-08-02 12:28:13 +10:00
gellert
439ad94afe Merge remote-tracking branch 'upstream/master' into speedup-gpu 2016-08-01 12:00:34 +02:00
Heilig Benedek
0eacee0058 add documentation for changes 2016-08-01 02:18:19 +02:00
Heilig Benedek
2b05be64b4 add documentation for changes 2016-08-01 02:14:45 +02:00
gellert
35ee99265e adds tests for osr 2016-07-31 17:10:53 +02:00
gellert
f60d791fa8 adds docs for osr 2016-07-31 00:22:34 +02:00
Milan Burda
e428d5db4f docs: fix argument types 2016-07-29 11:56:32 +02:00
Cheng Zhao
99b523176b Merge pull request #6619 from electron/web-contents-copy-image-at
Add webContents.copyImageAt(x, y)
2016-07-27 10:15:38 +09:00
Kevin Sawicki
31564f079f Document webContents.copyImageAt(x,y) 2016-07-26 12:08:05 -07:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
Cheng Zhao
c497765dea Merge pull request #6524 from liusy182/painted-event-6426
add "view-painted" event to WebContent.
2016-07-25 16:02:50 +09:00
liusy182
6e83f454d7 documentation error pointed out in issue #6541 2016-07-21 22:46:46 +08:00
Anthony Tseng
42eb0c3eae serial number in hex string 2016-07-18 23:42:42 +08:00
liusi
d335d7d706 add "view-painted" event to WebContent. 2016-07-18 14:54:52 +08:00
Cheng Zhao
9eacd07eda Merge pull request #6489 from electron/webcontents-static-api
Document static methods on webContents
2016-07-15 11:02:00 +09:00
Kevin Sawicki
297365b4f0 Add require example for webContents 2016-07-14 17:54:18 -07:00
Kevin Sawicki
4de4774325 Update headings/sections to follow docs styleguide 2016-07-14 17:46:58 -07:00
Cheng Zhao
3ace677b41 Merge pull request #6474 from darkdh/cert_detail
Add more detail attributes for certificate-error
2016-07-15 08:45:36 +09:00
Kevin Sawicki
c680c0b85e Document static webContents methods 2016-07-14 09:00:29 -07:00
Kevin Sawicki
e1459b7db7 Doc webContents.isFocused 2016-07-13 14:20:33 -07:00
Anthony Tseng
db39867ad9 Add more detail attributes for certificate-error 2016-07-13 22:14:47 +08:00
vsemozhetbyt
4f62050b01 Fix typo in the web-contents.md
📝 `false` -> `true` in the `webContents.print` `silent` explanation.

[ci skip]
2016-07-09 20:31:02 +03:00
Cheng Zhao
c70635daff docs: Some dlls are not there anymore 2016-07-07 10:17:49 +09:00
Kevin Sawicki
ce4ef1ccb8 Update capturePage documentation for new location 2016-07-06 09:21:28 -07:00
vsemozhetbyt
c2bf6c2460 Fix disordered definitions in webContents doc
📝 Swap `clearSelection` and `keepSelection` definitions
for `webContents.stopFindInPage(action)` that seems to be in wrong order.

[ci skip]
2016-07-06 18:58:50 +03:00
Cheng Zhao
f072d9dd3a docs: webContents.startDrag(item) 2016-07-03 15:10:59 +09:00
Cheng Zhao
e1ad64013e Cleanup code of beginFrameSubscription 2016-06-26 11:46:40 +09:00
Cheng Zhao
3d2ad0080d Merge pull request #6164 from MaxWhere/master
beginFrameSubscription bugfix and improvement
2016-06-26 02:39:59 +00:00
Heilig Benedek
5118def724 damaged -> dirty rename, fixed misc issues, changed signature, updated docs and added tests 2016-06-25 18:23:40 +02:00
Zeke Sikelianos
cfebf7aa6b fix list indentation 2016-06-23 10:36:16 -07:00
Zeke Sikelianos
2a079b2e0a wether → whether 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
a82a2485d7 fix debugger event headings 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
0d481aaeb8 📝 use h3 headings for events and methods, per the styleguide 2016-06-21 22:54:43 -07:00
Heilig Benedek
712141f153 Updated docs for beginFrameSubscription 2016-06-21 13:35:30 +02:00
Leonard Lamprecht
67dd19ed0f Replace OS X and Mac OS with macOS 2016-06-18 15:26:26 +02:00
Kevin Sawicki
094098b571 Correct typos in docs 2016-06-16 15:19:38 -07:00
Kevin Sawicki
ce19c2c0ad Document webContents.showDefinitionForSelection 2016-06-08 10:15:36 -07:00
Cheng Zhao
3c873736d7 Add update-target-url event 2016-06-07 15:56:19 +09:00
Kevin Sawicki
96ca8edbb4 javascript -> javascript 2016-06-02 09:39:17 -07:00
Cheng Zhao
e46ef5a15a Merge pull request #5824 from electron/cleanup-web-contents
Cleanup the web-contents.js code
2016-06-01 07:14:31 +00:00
Cheng Zhao
01b10b3b39 Slightly improve docs of webContents.printToPDF 2016-06-01 15:32:37 +09:00
deepak1556
7434838463 fix docs 2016-06-01 11:44:29 +05:30
deepak1556
51daf8e194 add docs 2016-06-01 11:43:39 +05:30
Vasu Mahesh
fc6628d159 Add: custom pageSize for printToPDF 2016-05-31 22:40:11 +05:30
Cheng Zhao
998ce73ad9 Add webContents.id property 2016-05-18 13:57:48 +09:00
Daniel Pham
1bac1a9028 📝 Fix styling of the context-menu docs
[ci skip]
2016-05-14 08:43:23 -04:00
Plusb Preco
5146befa46 📝 Match variable names
[ci skip]
2016-05-11 02:38:42 +09:00
Plusb Preco
f1b184ef78 📝 Fix code style issue
* Change `var` to `let`.
* Change `function() {}` to `() => {}`.
* Use shorthand function syntax on object notation.
* Remove spaces between object notation brackets.
* Small fixes.
2016-05-11 02:15:09 +09:00
Plusb Preco
139a4f984a 📝 Add missing semicolons
[ci skip]
2016-05-11 01:57:55 +09:00
Plusb Preco
4d7296e1db 📝 Match destructuring style
[ci skip]
2016-05-11 01:26:38 +09:00
Plusb Preco
5787bb0226 📝 Fix code style issue
* Match equality operators for consistent that `==`, `!=` by `===`,
`!==`.
* Match string expression notation `"` by `'`.

[ci skip]
2016-05-10 18:42:21 +09:00
Charlie Hess
69c4c7e3be Clarify how did-fail-load handles redirects. 2016-05-05 15:52:00 -07:00
Cheng Zhao
969a30fc3b Merge branch 'update-code-samples' of https://github.com/stevekinney/electron into stevekinney-update-code-samples 2016-05-05 20:55:25 +09:00
Cheng Zhao
0901a70166 Merge pull request #5379 from danhp/context-menu
Expose the 'context-menu' event.
2016-05-05 11:12:58 +09:00
Steve Kinney
5a9f28e034 📝 Update API documentation to ES6 [ci skip] 2016-05-04 11:59:02 -06:00
Daniel Pham
a6f2d401fa Follow object naming conventions for params in the 'context-menu' event 2016-05-04 10:41:10 -04:00
Daniel Pham
81eb3e3428 📝 Document 'context-menu' event 2016-05-03 17:52:24 -04:00
Sindre Sorhus
ad09196433 improve the webContents.openDevTools docs
consistent value notation and explain the difference between `undocked` and `detach` mode.
2016-05-02 14:39:46 +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
4f4277e25e 📝 Fix coding style issues
* Adjust line length to `80`
* Normalize whitespaces

[ci skip]
2016-04-22 22:54:43 +09:00
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
deepak1556
58dfad4d01 devtools: allow opening in specified dock state 2016-04-19 18:12:05 +05:30
Rob Brackett
50f51899de Document resourceType arg for did-get-response-details event. 2016-04-08 13:03:22 -07:00
Rob Brackett
884c9cc2f5 Document isMainFrame argument for WebContents did-fail-load event. 2016-04-04 19:36:34 -07:00
Robo
8378cbb1e8 webcontents: provide position of match with found-in-page event 2016-03-14 06:49:45 +05:30
Cheng Zhao
b7a40f3097 docs: Add missing key codes 2016-03-06 15:12:04 +09:00
Andrea Parodi
fd11b7e7db Removed duplicate isDevToolsFocused entry 2016-02-27 20:34:51 +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
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
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