Andrew MacDonald
7c5bd62158
Decrease title size.
2017-11-08 09:37:56 -08:00
Andrew MacDonald
00665b9501
Add documentation to web-contents.md.
2017-11-08 09:35:01 -08:00
Yuya Ochiai
6326c6727e
Add did-attach-webview event
2017-10-07 22:52:20 +09:00
rhysd
32ad59de26
Fix findInPage() documentation for correcting type definition
...
This update fixes the return type of `findInPage()`, which is currently
typed as `void` but actually it should be `number`.
2017-10-03 16:39:37 +09:00
Liu Siyuan
e64d4e5bd7
update web-content.md based on review
2017-08-23 23:37:37 +08:00
Liu Siyuan
15d2cfe458
update docs
2017-08-23 23:04:00 +08:00
Siyuan Liu
eeb2e58ad8
return null when theme color is not found
2017-08-20 22:48:13 +08:00
Cheng Zhao
ecff620528
Merge pull request #10081 from renaesop/master
...
Add a callback option to `webContents.print`
2017-08-17 15:56:02 +09:00
renaesop
6d16eb81d2
Add a callback option to webContents.print
2017-08-15 14:44:24 +08:00
Fabian Zeindl
5db02ffaa9
updates to the docs
2017-07-24 10:29:45 +02:00
Kevin Sawicki
4958771b8a
Merge pull request #9852 from electron/webcontents-ignorekeyboardshortcuts
...
Add webContents.setIgnoreMenuShortcuts()
2017-06-28 10:35:02 -07:00
Kevin Sawicki
0d1cf8af35
Mark contents.setIgnoreMenuShortcuts as experimental
2017-06-28 10:20:22 -07:00
Birunthan Mohanathas
f20f87829b
Add webContents.setIgnoreMenuShortcuts()
...
This allows you to disable application menu shortcut handling on a per
web contents basis.
2017-06-26 14:01:17 -07:00
Tim Fish
58a42682d8
Fixes electron/electron-typescript-definitions/issues/63
2017-06-25 10:43:47 +02:00
Birunthan Mohanathas
ece50c036d
Document webContents.focus()
2017-06-15 10:19:27 -07:00
Kevin Sawicki
f5989dc12f
Merge pull request #9615 from rajatsingla28/web
...
Docs: Add requirement for `webContents.sendInputEvent()` to work.
2017-06-05 10:03:48 -07:00
Kevin Sawicki
afa2dd5ce5
Minor updates to focus note
2017-06-05 10:03:25 -07:00
Rajat
2df7680d24
Docs: Add requirement for webContents.sendInputEvent() to work.
2017-06-03 23:47:15 +05:30
Rajat
a1da54047a
Docs : Add requirement for 'webContents.sendInputEvent()` to work.
2017-05-29 20:19:28 +05:30
Rajat
973945a8e3
Docs: Add BrowserWindow needs to be focused for webContents.sendInputEvent() to work.
2017-05-29 20:10:32 +05:30
Kevin Sawicki
b0d4bf81a0
Add backticks around return types
2017-05-26 13:58:14 -07:00
Kevin Sawicki
dcb22d34b5
Mark deviceName as optional
2017-05-26 13:33:03 -07:00
Kevin Sawicki
74b7afbec7
Merge origin/master into enable-webview
2017-05-19 10:17:34 -07:00
Kevin Sawicki
a8d25d6855
Add printer info structure file
2017-05-18 10:50:08 -07:00
Kevin Sawicki
e0b39247a9
Tweak print docs
2017-05-18 10:17:08 -07:00
Kevin Sawicki
92f14f8d52
printerList() -> getPrinters()
2017-05-18 10:14:55 -07:00
Kevin Sawicki
84a9b6a42d
Merge remote-tracking branch 'origin/master' into renaesop_master
2017-05-18 10:08:40 -07:00
Kevin Sawicki
6fccb75dfb
Mention preloadURL is in webPreferences
2017-05-17 13:59:48 -07:00
Kevin Sawicki
d79ac8d9c1
Merge pull request #9222 from alexstrat/add-os-process-id
...
Add OS pid to web-contents
2017-05-15 13:28:47 -07:00
Alexandre Lachèze
77bf4c8ebb
📝 document getOSProcessId()
2017-05-15 20:02:20 +02:00
Birunthan Mohanathas
5cfa697309
Fix postData type definition in docs
2017-05-14 13:43:38 +03:00
Kevin Sawicki
4e1943dfe6
Minor updates to example
...
* const-ing
* mainWindow -> win
* add dialog require
2017-05-11 09:01:51 -07:00
22222
4044548f3e
Add 'will-prevent-unload' event.
2017-05-11 06:35:35 -05:00
renaesop
cba5e96496
Merge remote-tracking branch 'ups/master'
2017-05-09 09:44:24 +08:00
Milan Burda
568454525d
Use point / size / rectangle structures consistently in API docs
2017-04-04 08:31:09 +02:00
Samuel Attard
f757912f90
Add missing finalUpdate prop
2017-04-01 12:11:34 +11:00
Samuel Attard
168c47bf10
Update web-contents.md
2017-03-25 18:27:43 +11:00
John Kleinschmidt
3c74404a3e
Updated docs.
2017-03-09 09:54:09 -05:00
John Kleinschmidt
1c2a78a896
Add WebRTCIPPolicy setting to webContents and webview
...
Resolves #8777
Code to set and get the policy come from the muon framework code:
https://github.com/brave/muon/blob/master/atom/browser/api/atom_api_web_
contents.cc#L1324...L1343
2017-03-08 10:15:48 -05:00
Kevin Sawicki
6bc464d4b0
Mention userGesture default
2017-03-06 10:51:48 -08:00
Nitish Sakhawalkar
370562b129
Moving data url test outside post navigation block. Trailing separator comment in the docs.
2017-03-02 12:14:18 -08:00
Nitish Sakhawalkar
e8c0813f46
Changes based on review.
2017-03-02 10:58:39 -08:00
Nitish Sakhawalkar
879082b1a6
Issue #8735:Support base URL option to loadURL for data URLs
2017-02-28 16:49:03 -08:00
Kevin Sawicki
eb260c3593
Update parameter prefix
2017-02-23 13:03:22 -08:00
popod
ea3b14f0bb
update startDrag(item) doc
...
add doc for `files` option
2017-02-23 21:28:36 +01:00
Kevin Sawicki
9be42db8d5
Merge pull request #8628 from Spacetech/master
...
Implement invalidate for non-offscreen mode
2017-02-14 11:41:16 -08:00
Kevin Sawicki
52d989f908
Update docs for non-offscreen invalidate
2017-02-14 11:17:39 -08:00
Fabian Zeindl
5efa34ce6d
Update web-contents.md
2017-02-12 10:03:33 +01:00
Kevin Sawicki
b92c4f6ce5
Merge pull request #8651 from electron/new-window-docs
...
[ci skip] Improve docs for `new-window` event
2017-02-10 10:29:07 -08:00
Kevin Sawicki
e85d2f00dd
Fix linting errors around spacing and semicolons
2017-02-10 08:49:13 -08:00
Vadim Macagon
035d9df29b
Fix example code
2017-02-10 18:02:03 +07:00
Vadim Macagon
197ad915b7
[ci skip] Improve docs for new-window event
...
This should help clarify the purpose of `event.newGuest` as per the recent discussion in #7407 .
2017-02-10 17:57:55 +07:00
Vadim Macagon
e8f0331aeb
Improve docs for will-attach-webview event
2017-02-10 10:33:33 +07:00
Kevin Sawicki
a7c050107b
Remove guest from will-attach-webview event
2017-02-09 11:47:45 -08:00
Kevin Sawicki
8b0d3a2567
Emit attach params as well in event
2017-02-09 11:45:07 -08:00
Kevin Sawicki
792f3c3030
Document will-attach-webview
2017-02-09 11:45:07 -08:00
renaesop
023a3fd547
Print enhancement: add webContents.printerList And a print option to select printer
2017-02-06 17:18:04 +08:00
Kevin Sawicki
604c2470bc
Merge pull request #8561 from liusy182/!-liusy182-br
...
add 'code' property in 'before-input-event''s 'input' argument
2017-02-02 10:33:20 -08:00
liusi
87392ff046
'before-input-event' is missing the code property #8471
2017-02-02 16:23:07 +08:00
Kevin Sawicki
eb6d92d427
Mention image cannot be empty on macOS
2017-01-26 15:46:04 -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
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
315daf1a10
Switch to footer link syntax
2017-01-12 16:54:07 -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
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
