Ryohei Ikegami
8dff29185b
Merge branch 'master' into native-window-open
2017-04-18 21:59:22 +09:00
Yuya Ochiai
75184046f6
Add events to manage sheets of macOS BrowserWindow
2017-04-15 16:26:45 +09:00
Birunthan Mohanathas
8b9f7e5b00
Implement initial, experimental BrowserView API
...
Right now, `<webview>` is the only way to embed additional content in a
`BrowserWindow`. Unfortunately `<webview>` suffers from a [number of
problems](https://github.com/electron/electron/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3Awebview%20 ).
To make matters worse, many of these are upstream Chromium bugs instead
of Electron-specific bugs.
For us at [Figma](https://www.figma.com ), the main issue is very slow
performance.
Despite the upstream improvements to `<webview>` through the OOPIF work, it is
probable that there will continue to be `<webview>`-specific bugs in the
future.
Therefore, this introduces a `<webview>` alternative to called `BrowserView`,
which...
- is a thin wrapper around `api::WebContents` (so bugs in `BrowserView` will
likely also be bugs in `BrowserWindow` web contents)
- is instantiated in the main process like `BrowserWindow` (and unlike
`<webview>`, which lives in the DOM of a `BrowserWindow` web contents)
- needs to be added to a `BrowserWindow` to display something on the screen
This implements the most basic API. The API is expected to evolve and change in
the near future and has consequently been marked as experimental. Please do not
use this API in production unless you are prepared to deal with breaking
changes.
In the future, we will want to change the API to support multiple
`BrowserView`s per window. We will also want to consider z-ordering
auto-resizing, and possibly even nested views.
2017-04-13 01:27:27 +03:00
Ryohei Ikegami
61fa8693d2
Merge branch 'master' into native-window-open
2017-04-04 20:54:37 +09:00
Milan Burda
568454525d
Use point / size / rectangle structures consistently in API docs
2017-04-04 08:31:09 +02:00
Kevin Sawicki
6f27d466a5
Move tabbingIdentifier out of webPreferences list
2017-03-30 13:49:00 -07:00
Tony Ganch
a7565f0d57
Enable native tabs on macOS
2017-03-29 13:51:39 +02:00
Kevin Sawicki
870dcb9071
Remove old sandbox option in list and mark as experimental
2017-03-27 10:14:47 -07:00
Thiago de Arruda
437f1192d9
Add initial documentation for sandbox option.
2017-03-23 21:42:25 -03:00
Ryohei Ikegami
6f9dbd4e04
Merge branch 'master' into native-window-open
2017-03-24 00:11:43 +09:00
Cheng Zhao
ab83aa0bfd
docs: Multithreading
2017-03-20 12:52:46 -07:00
Kevin Sawicki
6ded27f3a9
Merge pull request #8878 from TanninOne/patch-1
...
Update browser-window.md
2017-03-20 10:14:23 -07:00
Kevin Sawicki
caae03f954
Use rendered language in both ready-to-show docs
2017-03-20 10:13:45 -07:00
Ryohei Ikegami
88f062958f
Fix option doc
2017-03-19 20:21:03 +09:00
Ryohei Ikegami
afdf52b053
Add docs for useNativeWindowOpen
2017-03-19 18:37:38 +09:00
Kevin Sawicki
6f047fd4b7
Mark touch bar apis with _Experimental_
2017-03-17 10:56:41 -07:00
TanninOne
410e80682a
Update browser-window.md
...
Notes that maximize will also show the window and that ready-to-show won't fire if the window is already being displayed. (See issue #8861 )
2017-03-09 15:41:31 +01:00
Kevin Sawicki
bb8d42f1e1
Mark TouchBar as experimental
2017-03-07 09:42:45 -08:00
Kevin Sawicki
f549bda9fc
Merge pull request #8799 from nitsakh/baseURLForDataURL
...
Support base URL option to loadURL for data URLs
2017-03-06 10:25:53 -08:00
Kevin Sawicki
fde310f50d
Mention it only effects 10.12.1 with touch bar
2017-03-03 14:04:55 -08:00
Kevin Sawicki
002369576f
Add initial touch bar docs
2017-03-03 14:00:39 -08:00
Samuel Attard
61949657f0
Some docs for touch bar
2017-03-03 14:00:38 -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
Oden
c10f1210bc
📝 Update link to Blink features.
2017-02-26 20:34:00 -08:00
PoppinL
9b8e4eb6cb
Fix typo
...
Fix typo
2017-02-13 16:14:49 +08:00
Cheng Zhao
2e0780308c
allowDisplayingInsecureContent is removed by Chrome
2017-02-06 10:34:29 -08:00
Kevin Sawicki
2cacaa443a
Indent relativeLevel docs
2017-01-30 15:27:51 -08:00
leethomas
fb741285c6
update documentation
2017-01-23 23:42:38 -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
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
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
Dustin
2e1feb63e4
Corrected some grammatical errors
2016-12-19 19:01:35 -08: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
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
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
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
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
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
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
Tereza Tomcova
b305020c1d
Added documentation for BrowserWindow.setAppDetails
2016-11-18 21:43:03 +01: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
c9739abf7f
add description and process for BrowserWindow class
2016-11-16 09:02:49 -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
Kevin Sawicki
4de2493d89
Move footer links to bottom
2016-11-11 10:22:27 -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
Zeke Sikelianos
ac68de6215
document process(es) for all APIs
2016-11-03 10:26:00 -07:00
Samuel Attard
02a7094529
Follow docs style guide for string ENUMS
2016-10-26 16:19:41 +11:00
Samuel Attard
7078ed80fa
Move webPreferences and titleBarStyle to the correct place in the docs
...
In their previous location `electron-docs-linter` would not output an Object structure for `webPreferences` (which is a key part of the constructor)
2016-10-26 14:31:30 +11:00
Kevin Sawicki
d85c4da11b
Minor formatting tweaks
2016-10-26 09:55:34 +09:00
Kevin Sawicki
d982376fc4
filename -> displayName
2016-10-26 09:47:38 +09:00
Pierre Laurac
b44371f4bf
filename as Optional argument
2016-10-26 09:05:01 +09:00
Pierre Laurac
9736dc3115
Specifying macOS only method
2016-10-26 09:04:30 +09:00
Pierre Laurac
4d305b06d1
Adding documentation
2016-10-26 09:03:14 +09:00
Mike Engel
6f64ad30cb
Clarify the setMenuBarVisibility api
...
The setMenuBarVisibility api is only supported on Windows and Linux.
This adds some minor documentation to make that clearer. Fixes #7686
2016-10-24 22:04:45 -06:00
Samuel Attard
20323e7032
Specifiy function param types in docs
2016-10-13 17:30:57 +11:00
Samuel Attard
4d49156dac
Rename bounds -> rectangle
2016-10-08 13:09:31 +11:00
Samuel Attard
b859afc118
Update docs to follow the 'link first instance' standard
2016-10-06 12:19:38 -07:00
Milan Burda
9f342ebbd1
Add missing documentation
2016-10-06 11:30:34 +02:00
Cheng Zhao
e1d68fa3cd
Merge pull request #7374 from electron/fixup-return-values
...
Update docs to contain more specific return values
2016-09-29 16:44:08 +08:00
Kevin Sawicki
fd6ef6712f
Link to window level macOS docs
2016-09-28 09:20:22 -07:00
Cheng Zhao
de76bf5f63
Merge pull request #7296 from adammeyer/custom-window-level
...
Allow custom window level when sending window to top
2016-09-28 19:18:12 +08: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
adammeyer
783d47f78b
custom window level as string
2016-09-21 22:49:06 -04:00
adammeyer
b35bde662a
custom window level docs
2016-09-21 19:06:36 -04:00
Kevin Sawicki
98999f4850
Add missing s in progress
2016-09-20 14:46:17 -07:00
Anthony Tseng
269a87b26f
Emit scroll-touch-edge event instead of changing the behavior of scroll-touch-begin/end
...
fix #6873
2016-09-17 22:50:10 +08:00
Cheng Zhao
4eba8094d4
Merge pull request #7096 from minggo/add-option-to-disable-devtools
...
add option to disable devtools
2016-09-13 16:01:56 +09:00
minggo
3fdc99c3c6
change the option name to devTools
2016-09-07 10:16:52 +08:00
minggo
2db5aa8294
update browser-window.md to add disableDevTools option
2016-09-06 17:46:55 +08:00
Milan Burda
9911e60f5b
Add support for titleBarStyle: 'hidden-inset' on OS X 10.9
2016-09-03 01:33:20 +02:00
Zeke Sikelianos
28d42ba35b
document missing method parameters
2016-08-25 10:52:19 -07:00
Zeke Sikelianos
84fc1d022f
add missing require to win.loadURL doc
2016-08-22 14:25:48 -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
1985432e8e
recommend url.format for file URLs
2016-08-19 13:31:57 -07:00
Zeke Sikelianos
d9901e62b6
improve doc for loadURL
2016-08-18 22:20:55 -07:00
Cheng Zhao
b9b6fc238e
docs: Correctly fomart titleBarStyle line
2016-08-18 14:42:10 +09:00
Cheng Zhao
105597c7e8
Merge pull request #6848 from miniak/titlebar-style-hidden
...
Add support for titleBarStyle: 'hidden' on OS X 10.9
2016-08-18 14:40:54 +09:00
Milan Burda
ab8fd49c72
Add support for titleBarStyle: 'hidden' on OS X 10.9 (hidden-inset falls back to hidden)
2016-08-15 22:10:38 +02:00
Stan
c9f80dfc7b
Added title to page-title-updated return args
2016-08-15 13:06:29 -04:00
Cheng Zhao
81244c2221
Merge pull request #6768 from electron/felix-set-progress
...
Enable mode indication for setProgressBar
2016-08-09 20:58:07 +09:00
Felix Rieseberg
73c91dae9e
🔧 Enable mode indication for setProgressBar
...
This commit enables setting a mode for the setProgressBar method.
Old behavior is kept intact, usage is entirely optional.
2016-08-08 15:52:20 -07:00
Milan Burda
a6125c538e
Add BrowserWindow.prototype.setThumbnailToolTip
2016-08-08 12:05:47 +02:00
Kevin Sawicki
01f95c149a
Doc BrowserWindow.setContentBounds
2016-08-04 12:15:29 -07:00
Kevin Sawicki
a868bffd73
Document BrowserWindow.getContentBounds()
2016-08-04 09:58:36 -07:00
Kevin Sawicki
05ab7d39ad
Mark isDestroyed as public on BrowserWindow/WebContents
2016-08-03 14:58:22 -07:00
gellert
439ad94afe
Merge remote-tracking branch 'upstream/master' into speedup-gpu
2016-08-01 12:00:34 +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
Zeke Sikelianos
06a354a2eb
standardize all javascript blocks in English docs
2016-07-26 09:48:19 -07:00
Cheng Zhao
b57665330c
Merge branch 'master' into chrome52
2016-07-21 05:34:36 -06:00
Kevin Sawicki
e24885b160
Mention how to reset thumbnail to entire window
2016-07-15 10:38:11 -07:00
Cheng Zhao
52808d5342
Merge pull request #6499 from electron/drop-vista
...
Remove implicit references to Vista in docs
2016-07-15 10:20:14 +09:00
Kevin Sawicki
1aa645522a
Remove implicit references to Vista
2016-07-14 17:33:48 -07:00
Kevin Sawicki
f4a160d0fb
Add properties as sub-list
2016-07-14 16:02:06 -07:00
Kevin Sawicki
ccee3e1fc2
Document setThumbnailClip
2016-07-14 15:54:57 -07:00
Zeke Sikelianos
2486512c71
use h3/h4 for instance headings and children
2016-07-12 21:42:08 -07:00
Zeke Sikelianos
f8045fd743
💄
2016-07-12 21:40:46 -07:00
Zeke Sikelianos
6d8a6e6471
use consistent wording for instances
2016-07-12 21:30:27 -07:00
Zeke Sikelianos
a304a59d36
use h3/h4 for static method headings and methods
2016-07-12 21:29:09 -07:00
Zeke Sikelianos
fff036b6ab
distinguish static methods from module methods
2016-07-12 21:28:27 -07:00
Zeke Sikelianos
a08ee97fb0
use h3/h4 for instance events headings and events
2016-07-12 21:24:22 -07:00
Zeke Sikelianos
67dbff1d4a
events -> instance events
2016-07-12 21:22:54 -07:00
Zeke Sikelianos
e866c68938
📝 minor style changes and typos
2016-07-12 21:21:25 -07:00
Plusb Preco
9ea4039887
📝 Fix grammatical typo
...
[ci skip]
2016-07-13 03:02:14 +09:00
Plusb Preco
19765e70cf
📝 Fix typo
...
[ci skip]
2016-07-13 02:57:11 +09:00
Cheng Zhao
e8e2763131
win: Add toolbar type for BrowserWindow
2016-07-11 12:46:50 +09:00
Cheng Zhao
b70090170d
docs: thickFrame option
2016-07-09 21:52:45 +09:00
Kevin Sawicki
ce4ef1ccb8
Update capturePage documentation for new location
2016-07-06 09:21:28 -07:00
Cheng Zhao
8d3e09747a
directWrite option is removed
2016-07-05 09:20:57 +09:00
Cheng Zhao
fa023842d3
Merge pull request #6111 from electron/docs-formatting
...
Docs formatting
2016-06-24 00:24:57 +00:00
Zeke Sikelianos
3dcbbe9f20
remove parens from type
2016-06-23 14:13:03 -07:00
Milan Burda
c243cf0c0f
Add BrowserWindow.prototype.setContentProtection(enable)
2016-06-22 10:40:33 +02:00
Zeke Sikelianos
72403c1a8d
use consistent verb style
2016-06-21 22:56:51 -07:00
Zeke Sikelianos
90d1b9169f
prepositions are hard
2016-06-21 22:55:26 -07:00
Cheng Zhao
f7a9b1ae04
docs: modal window is greatly simplified
2016-06-20 16:00:38 +09:00
Cheng Zhao
946d246aea
docs: Parent and child windows
2016-06-20 11:21:34 +09:00
Leonard Lamprecht
67dd19ed0f
Replace OS X and Mac OS with macOS
2016-06-18 15:26:26 +02:00
Kevin Sawicki
6709e3c338
Mark which APIs are unavailable before app ready
2016-06-17 15:06:59 -07:00
Cheng Zhao
fc09c98bec
Use once for 'ready-to-show'
2016-06-13 22:19:44 +09:00
Cheng Zhao
8a50a1b9d3
docs: Showing window gracefully
2016-06-13 22:11:40 +09:00
Cheng Zhao
e284deb7e1
docs: The side effect of focusable: false on Linux
2016-06-13 17:53:08 +09:00
Cheng Zhao
50f1837097
On Windows focusable: false also means skipTaskbar: true
2016-06-13 17:24:45 +09:00
Cheng Zhao
8eca728e0a
Add focusable option
2016-06-13 17:10:28 +09:00
Cheng Zhao
5aecd10502
docs: Document the behavior of win.setIgnoreFocus on OS X
2016-06-13 16:40:02 +09:00
Cheng Zhao
ce00f4a273
Merge pull request #6013 from miniak/setIgnoreFocus
...
Add BrowserWindow.prototype.setIgnoreFocus
2016-06-13 07:18:10 +00:00
