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
Milan Burda
7a1d1ee0ea
Add BrowserWindow.prototype.setIgnoreFocus
2016-06-12 20:20:57 +02:00
Kevin Sawicki
f9b7033f43
Fix typo in example
2016-06-10 09:34:34 -07:00
Kevin Sawicki
2804272c7d
Doc getDevToolsExtensions
2016-06-10 09:29:26 -07:00
Kevin Sawicki
091682a039
Doc BrowserWindow.isDevToolsExtensionInstalled
2016-06-10 09:24:04 -07:00
Kevin Sawicki
ce19c2c0ad
Document webContents.showDefinitionForSelection
2016-06-08 10:15:36 -07:00
Cheng Zhao
3ec4fcb3ec
bellow => below
2016-06-08 11:03:01 +09:00
Kevin Sawicki
c7f2c25bc9
Mention enabling/disabling
2016-06-07 13:59:30 -07:00
Kevin Sawicki
636e356977
Document disableBlinkFeatures option
2016-06-07 13:56:33 -07:00
Kevin Sawicki
b941e25bf5
Link to RuntimeEnabledFeatures.in
2016-06-07 13:55:44 -07:00
Cheng Zhao
6192eef1b6
Update docs on win.setIgnoreMouseEvents
2016-06-07 20:32:52 +09:00
Felix Rieseberg
b42e6583f7
🎨 Log a warning if an extension has already been loaded
...
If an extension has already been loaded (for instance because it’s
persisted), `addDevToolsExtension` will return nothing, which is
confusing. This adds a little `console.warn` to educate people about
what’s happening.
Closes #5854
2016-06-03 14:32:22 -07:00
Cheng Zhao
09796587b4
Remove trailing whitespaces and cleanup the code logic
2016-05-30 09:12:16 +09:00
Cheng Zhao
ec53e49fad
Merge pull request #5718 from felixrieseberg/windows-fullscreenable
...
Fix setFullscreen() on Windows
2016-05-30 00:08:16 +00:00
Kevin Sawicki
1704b1ad53
Remove APIs that are no longer present
2016-05-27 15:08:29 -07:00
Felix Rieseberg
836f8ab33c
🐛 Fix setFullscreen() on Windows
...
This ensures that a BrowserWindow responds to `setFullscreen(true)` if
`full screenable` was not defined during creation.
This bug was on Windows only.
2016-05-26 11:52:25 -07:00
Cheng Zhao
28e2058ff1
Merge pull request #5648 from electron/chrome51
...
Update to Chrome 51
2016-05-24 10:59:11 +00:00
Daniel Pham
5010150c8c
📝 Mention that x and y have to be used together when creating new window
...
[ci skip]
2016-05-23 13:00:43 -04:00
Cheng Zhao
fa0ce7ad5f
Adjust to the new behaviors of beforeunload handler
2016-05-23 14:27:39 +09:00
Cheng Zhao
6f3d0e1782
Merge pull request #5603 from leethomas/osx-horizontal-sheet-offset
...
Osx horizontal sheet offset
2016-05-21 14:07:53 +00:00
Cheng Zhao
a93c9462ed
Add BrowserWindow.setIcon
2016-05-20 22:22:15 +09:00
Cheng Zhao
b33c04d041
docs: Recommend to use ICO icon
2016-05-20 19:58:47 +09:00
leethomas
9196a9f334
update docs
2016-05-19 20:32:14 -07:00
leethomas
eaacbc86c7
📝 update english docs to include setSheetOffsets
2016-05-18 23:59:25 -07:00
Andrew Murray
2d19d8108b
Fixed typo
2016-05-12 08:14:17 +10: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
4d7296e1db
📝 Match destructuring style
...
[ci skip]
2016-05-11 01:26:38 +09:00
Cheng Zhao
df397dab30
Add scrollBounce option and disable it by default
2016-05-06 14:57:43 +09:00
Cheng Zhao
a4405dad45
docs: Make it clear that size constraints only apply for users
...
[ci skip]
2016-05-06 14:21:19 +09:00
Steve Kinney
5a9f28e034
📝 Update API documentation to ES6 [ci skip]
2016-05-04 11:59:02 -06: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
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
4f4277e25e
📝 Fix coding style issues
...
* Adjust line length to `80`
* Normalize whitespaces
[ci skip]
2016-04-22 22:54:43 +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
Ben Gotow
8f89cd2d59
Move "setSheetOffset" to the BrowserWindow
2016-04-18 22:39:12 -07:00
Andrew Dassonville
12483486c0
Update link to setFeatureEnabledFromString
2016-04-17 23:04:02 -07:00
Cheng Zhao
d156846036
Add backgroundThrottling option to webPreferences
2016-04-08 15:54:33 +09:00
Cheng Zhao
eb82f7cea9
Update docs for backgroundColor
2016-04-03 13:55:33 +09:00
James Wheare
d4a14bc215
Improve app-command docs, list arguments and explain command string
2016-03-31 08:56:49 +01:00
James Wheare
8482109dea
Switch to a single OS X swipe event with a direction argument
2016-03-23 15:20:11 +00:00
James Wheare
03319a5426
OSX: Capture 3-finger swipe events in NativeWindow
2016-03-18 15:21:19 +00:00
Cheng Zhao
03ec5ced05
Merge pull request #4751 from maxbeatty/window-blur
...
Add blur method to window
2016-03-11 19:15:51 +09:00
