Commit graph

713 commits

Author SHA1 Message Date
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
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
Max Beatty
704b8335aa Add blur method to window ref #4724 2016-03-10 21:45:51 -08:00
Arek Sredzki
c1267b2320 Added 'show' & 'hide' events to browser-window, fixed visibilitychange event in renderer 2016-03-10 13:51:31 -08:00
Heilig Benedek
bb42c85df8 resolve update conflicts 2016-02-27 03:23:10 +01:00
Heilig Benedek
bb0ac688b2 Reverted SetFullscreenable disabling maximize button on Windows and removed that from the docs. 2016-02-27 03:07:53 +01:00
Heilig Benedek
39bb670719 Revert will-enter-full-screen event, matching osx fullscreen: false behaviour on windows instead 2016-02-22 10:23:56 +01:00
Cheng Zhao
e47a815c38 Merge pull request #4482 from lukeapage/patch-7
spelling fixes and americanisms
2016-02-16 20:22:31 +08:00
Cheng Zhao
fded8d80b1 docs: Remove unnecessary "properties: " suffix 2016-02-16 12:11:05 +08:00
Luke Page
a141d6b3d4 spelling fixes and americanisms 2016-02-15 06:51:20 +01:00
Heilig Benedek
157a290e38 📝 Adding documentation for will-enter-full-screen event 2016-02-09 02:41:19 +01:00
chris-ls
48c6692311 Clarify overlay description
'16px' is ambiguous and not clear (4 x 4 px? or 16 x 16px)
2016-02-04 15:36:41 +13:00
Cheng Zhao
a83aee90e5 No need to use scoped_nsobject for id 2016-01-25 15:15:58 +08:00
Cheng Zhao
7761815339 Merge branch 'bg-color-pr' of https://github.com/evgenyzinoviev/electron 2016-01-24 21:33:53 +08:00
Cheng Zhao
5372b6cd91 Fullscreenable => FullScreenable 2016-01-24 14:31:36 +08:00
Cheng Zhao
31624995bc Merge pull request #4202 from evgenyzinoviev/shadow-pr
Added hasShadow option to BrowserWindow on OS X
2016-01-22 23:56:38 -08:00
Cheng Zhao
8cabe0f008 Merge pull request #4156 from evgenyzinoviev/windows-pr
Improvements in BrowserWindow
2016-01-22 23:42:41 -08:00
evgenyzinoviev
000af78d41 doc fix 2016-01-23 01:37:18 +01:00
evgenyzinoviev
e071e4f310 doc updated 2016-01-23 01:20:42 +01:00
evgenyzinoviev
ff41b4a267 added hasShadow option to BrowserWindow (osx) 2016-01-23 01:16:08 +01:00
evgenyzinoviev
3182504969 maximizable, fullscreenable docs 2016-01-22 23:32:09 +01:00
Cheng Zhao
21f5e27a5e Merge pull request #4161 from gabriel/master
Support backgroundColor for window on mac
2016-01-21 15:42:21 -07:00
Cheng Zhao
000625e23f Merge pull request #4163 from deepak1556/web_preferences_fonts_patch
browser: add font related settings to webpreferences
2016-01-21 14:35:30 -07:00
Gabriel Handford
239baa3e9a Support backgroundColor for window on mac 2016-01-21 11:07:33 -08:00
Robo
8a00406862 browser: add font related settings to webpreferences 2016-01-21 13:30:05 +05:30
Cheng Zhao
5bd2d4b08d docs: win.destroy() is safe 2016-01-20 09:46:38 -07:00
evgenyzinoviev
c3049e1e99 docs updated 2016-01-19 16:14:59 +01:00
Cheng Zhao
712f11a9a3 Merge pull request #4112 from evgenyzinoviev/resize-animate-pr
Animate window resizing on OS X
2016-01-16 12:12:00 +08:00
evgenyzinoviev
b75dccb0be arguments handing rewritten, doc updated 2016-01-15 17:31:31 +01:00
Cheng Zhao
d6e2db22b3 Merge pull request #4116 from 0b61d29/patch-1
Spelling: bellow → below
2016-01-15 23:33:25 +08:00
evgenyzinoviev
4b0119f996 added a note that this option is only implemented on osx 2016-01-15 16:02:23 +01:00
Florian Hämmerle
187cb54c25 spelling: bellow -> below 2016-01-15 13:43:44 +01:00
evgenyzinoviev
f93d890874 Fix doc 2016-01-15 06:00:06 +01:00
evgenyzinoviev
2598b00b41 Animate window resizing on OS X 2016-01-15 05:59:58 +01:00
evgenyzinoviev
cda88db77c Added option to prevent a window from being moved on OS X 2016-01-15 03:58:57 +01:00
Cheng Zhao
6d850ea61f docs: Mention the session object 2016-01-12 10:59:45 +08:00
Cheng Zhao
9e82334b67 Merge pull request #4057 from princejwesley/browser-window
Return null for no focused window when calling BrowserWindow.getFocusedWindow
2016-01-11 22:53:38 +08:00
Prince J Wesley
018ae5189b Return null for no focused window when calling BrowserWindow.getFocusedWindow() 2016-01-11 12:58:44 +05:30
Cheng Zhao
1944472c2f docs: Make win.getNativeWindowHandle more clear 2016-01-11 13:43:24 +08:00
Omri Litov
a4636ba18c Update browser-window.md 2016-01-08 20:53:59 +02:00
Omri Litov
224955d6ac Update browser-window.md 2016-01-07 23:17:23 +02:00
Cheng Zhao
c0e728ab6a docs: Orgnize the options of BrowserWindow 2016-01-07 14:23:21 +08:00
Cheng Zhao
3f2b26ddb7 Add blinkFeatures option 2016-01-07 14:10:18 +08:00
Cheng Zhao
16d23bbda5 Remove pageVisibility option
The original purpose of this option is not working anymore, also adds
docs on the current way to disable process backgrounding.
2016-01-07 12:28:20 +08:00
Cheng Zhao
c6e03f8390 Remove overlayScrollbars and sharedWorker options
They are already enabled by default.
2016-01-07 12:17:19 +08:00
Laekh
fdef3d56b8 Update browser-window.md
Made it more clear on how to define BrowserWindow (outside of the main process, specifically)
2015-12-11 11:20:44 +08:00
Cheng Zhao
7bb3bf0f48 docs: win.setIgnoreMouseEvents 2015-12-09 12:05:47 +08:00
Cheng Zhao
73e7773d84 Update to API changes of Chrome 47 2015-12-07 19:56:23 +08:00
Cheng Zhao
ba8b448c36 docs: Add indent for items in list
Some markdown renderers require it to be able to render the list
correctly.
2015-11-23 16:59:15 +08:00
Eran Tiktin
651254424d Expand the descriptions of options with defaults
Resolves #3367
2015-11-21 21:50:23 +02:00
Eran Tiktin
ab693ca571 Update docs 2015-11-21 06:42:40 +02:00
Cheng Zhao
8e2faba8f7 Small style fix 2015-11-20 13:06:42 +08:00
Ben Gotow
65c823407d Address feedback 2015-11-19 10:14:14 -08:00
Ben Gotow
d427ae1030 Support the "desktop" window type on Mac OS X
Adds the desktop window type referenced in https://github.com/atom/electron/issues/2899 for compatiblity with the linux version. Note that on Mac OS X, the desktop window cannot receive input events (seems to be a limitation of being behind the desktop).

In this diff I also removed the `standardWindow` option from the docs, in favor of an additional `textured` value for window `type` on Mac OS X. The old `standardWindow` option continues to work, but seemed more confusing. If this seems like a bad idea, I can revert that change.
2015-11-19 00:39:45 -08:00
Cheng Zhao
afbceab2ab Merge pull request #3496 from preco21/master
Update as upstream and some fixes
2015-11-19 10:57:21 +08:00
Eran Tiktin
f581730516 Update browser-window.md
Changed the description of the preload key to make it clear you need to provide an absolute file path and not a file url.
Also mentioned that it's possible to reintroduce Node globals when node integration is off and referenced the example from process.md (related to https://github.com/atom/electron/issues/254#issuecomment-157769756).
2015-11-18 21:06:06 +02:00
Plusb Preco
ef64a211a2 Standardize platform labels 2015-11-19 04:01:50 +09:00
Plusb Preco
0c2d769b8a Fix platform label to uppercase 2015-11-18 23:35:36 +09:00
Plusb Preco
0e8ab0688d Fix wrong markdown 2015-11-18 09:43:28 +09:00
Plusb Preco
0dd14ad204 'app-command' event is only available in Windows 2015-11-18 09:36:14 +09:00
Cheng Zhao
fbb8e61958 Replace "Url" in API names with "URL" 2015-11-13 16:03:40 +08:00
Cheng Zhao
eac2e7cc61 docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00
Cheng Zhao
28db51ad83 docs: Update BrowserWindow's options 2015-11-11 23:56:17 +08:00
Simon Knight
8cd8495df7 fix capital I -> i in isDocumentEdited
Uncaught Exception:
TypeError: mainWindow.IsDocumentEdited is not a function
2015-10-30 16:10:46 +10:30
Omri Litov
e355532d27 Change windows messages api to hook instead of emitter 2015-10-27 14:00:08 +02:00
Omri Litov
edbebf84b9 Added browser-window event 'message' 2015-10-27 03:12:01 +02:00
Cheng Zhao
83ef23ff8d docs: background-color on Windows 2015-10-23 13:32:04 +08:00
Cheng Zhao
f7840e7379 docs: background-color is Linux-only for now 2015-10-22 14:16:17 +08:00
Robo
9411508d3e browser: option to set window background color 2015-10-22 09:54:29 +05:30
Cheng Zhao
7bdbe45c91 subpixel-font-scaling option is removed 2015-10-16 15:01:28 +08:00
Cheng Zhao
af971a46bd docs: Move devtools methods to WebContents 2015-10-01 16:30:31 +08:00
Alexander Rusakov
d5f81357b6 remove required width and height BrowserWindowOptions 2015-09-30 17:13:20 +03:00
Cheng Zhao
d8062ab9e1 docs: win.setMenu is not available on OS X 2015-09-23 11:45:51 +08:00
Cheng Zhao
1e918480b4 docs: webContents.beginFrameSubscription 2015-09-18 17:53:19 +08:00
Cheng Zhao
573892c112 docs: webContents.sendInputEvent 2015-09-18 17:44:11 +08:00
Cheng Zhao
ee0d48dc5a Merge branch 'master' of https://github.com/MaxWhere/electron into MaxWhere-master 2015-09-18 12:01:33 +08:00
Cheng Zhao
69cc3ab5ef docs: Make description of fullscreen more precise
Closes #2793.
2015-09-16 09:20:16 +08:00
Heilig Benedek
ceef06b344 Renamed setOffscreenRender to begin/endFrameSubscription because the name was a bit misleading, and replaced the ArrayBuffer creation with a node::Buffer::New call. 2015-09-16 02:59:16 +02:00
Cheng Zhao
c9ee6b4caf docs: BrowserWindow.isDevToolsFocused 2015-09-15 11:43:45 +08:00
jaanus
5d8f1dd404 Implements #2734 “New API to configure BrowserWindow title bar on Mac”
New API supported on Yosemite 10.10 and newer.
2015-09-14 16:50:00 +02:00
Jessica Lord
39bd10d1ef Merge pull request #2757 from atom/jl-web-contents-links
Update Documentation Links to web-contents
2015-09-10 14:48:33 -07:00
Jessica Lord
aae2d82c28 Update links to web-contents.md 2015-09-10 12:19:37 -07:00
Jessica Lord
2ac2392a6b 🔥 extra line 2015-09-10 12:11:40 -07:00
Jessica Lord
7c287d565d Resolve conflicts 2015-09-10 12:09:37 -07:00
Jessica Lord
b861a174ca Merge pull request #2750 from atom/jl-doc-bits
A Few More Documentation Things
2015-09-10 10:41:42 -07:00
Heilig Benedek
b2af370249 Changed StringArray options to regular js objects with boolean values for better readability from the js side 2015-09-10 02:10:47 +02:00
Jessica Lord
c29a2e4992 Standardize DevTools 2015-09-09 14:11:06 -07:00
Jessica Lord
279fd0a461 Standardize **Note:** 2015-09-09 14:09:14 -07:00
Jessica Lord
1a35d6bda6 🔥 extra lines 2015-09-09 14:00:37 -07:00
Jessica Lord
5593717d78 Create Instance Properties section 2015-09-09 13:57:35 -07:00
Jessica Lord
6abc4fb255 🔥 odd, stray + 2015-09-09 13:48:04 -07:00
Cheng Zhao
512f89910d docs: No more extra-plugin-dirs 2015-09-06 11:07:38 +08:00
Cheng Zhao
2454dccde0 docs: preload, node-integration, zoom-factor have been moved 2015-09-06 10:54:34 +08:00
Timothy Cyrus
2f41641139 Update browser-window.md
Fix App Command Web Link
2015-09-02 15:44:51 -04:00
Heilig Benedek
dbcd0a4235 Key event sending update. 2015-09-02 02:33:40 +02:00
gellert
58081ca9e9 setOffscreenRender and api docs added 2015-08-29 00:45:00 +02:00
Jessica Lord
71fa87e4ed Note about platform specific apis 2015-08-26 14:14:59 -07:00
Jessica Lord
4e781eb042 Add platform labels 2015-08-26 14:05:47 -07:00
Jessica Lord
5f1897713c Edits, grammar, punctuation and merge conflicts 2015-08-26 13:57:42 -07:00
Jessica Lord
38b519ceb5 Add (optional) notation 2015-08-26 10:45:57 -07:00
Jessica Lord
71f74f4042 Add platform label where applicable 2015-08-26 10:45:57 -07:00
Jessica Lord
c282d4c0ff Line wrap 80-col 2015-08-26 10:45:57 -07:00
Jessica Lord
00de81771c Text edits per commit comments 2015-08-26 10:45:16 -07:00
Jessica Lord
840095b444 Break out methods, standardize 2015-08-26 10:45:15 -07:00
Plusb Preco
5a37f96434 Remove comments about remote buffer
Remove comments about remote buffer in browser-window.md, because remote
buffer now supports in remote module.
2015-08-25 10:14:52 +09:00
Cheng Zhao
8cc602ff94 Merge pull request #2515 from atom/fix-no-print-background
Fix a typing error in option checking: printBackgrounds => printBackground
2015-08-21 09:02:08 +08:00
Haojian Wu
4e6dc49646 📝 Fix a typing error: printBackgrounds => printBackground 2015-08-19 09:44:33 +08:00
Eran Tiktin
129d92b30a Update browser-window.md
Update the `beforeunload` example to use `e.returnValue = false` instead of `return false`, since `e.returnValue` always works while the `return` works only in certain conditions. See #2481 for details.
2015-08-18 19:34:14 +03:00
Cheng Zhao
958658513c Refactor code in taskbarHost 2015-08-06 12:44:07 +08:00
Haojian Wu
78eac4116c Polish thumbar code.
* Fix a memory leak in thumbar initialization.
* Check the number of thumbar buttons, should be <= 7.
* Correct to check thumbar button click event.
2015-08-05 19:38:12 +08:00
Haojian Wu
97ab780305 📝 BrowserWindow.setThumbarButton API. 2015-08-05 13:55:04 +08:00
Cheng Zhao
e135bcb5b7 docs: userGesture is optional 2015-08-03 14:43:01 +08:00
Robo
9fb03d584c add spec and fix docs 2015-07-31 12:30:17 +05:30
Robo
239d535cac render: executejavascript with option to simulate usergesture 2015-07-30 15:38:46 +05:30
Cheng Zhao
bbce2c7e2f Merge pull request #2372 from atom/allow-insecure-content
Add allowing-insecure-content option
2015-07-30 09:38:27 +08:00
Haojian Wu
f154da38e6 Make 'allow-displaying-insecure-content' and
'allow-running-insecure-content' higher priority than `web-security`.
2015-07-29 18:08:44 +08:00
Cheng Zhao
898a838ad7 Merge pull request #2340 from atom/set_download_path_api
Implement setDownloadPath API.
2015-07-29 17:19:02 +08:00
Haojian Wu
1d0568dd5b 📝 allow-running-insecure-content and
`allow-displaying-insecure-content`.
2015-07-29 16:17:14 +08:00
Haojian Wu
f40155645c 📝 say more about setDownloadPath API. 2015-07-29 14:13:28 +08:00
Robo
66553eea1a webContents: api to add/remove path from devtools workspace 2015-07-29 09:29:38 +05:30
Haojian Wu
7f0cb0ce1b 📝 session.setDownloadPath API. 2015-07-26 16:52:02 +08:00
Haojian Wu
74f2e9f102 📝 pageSize option. 2015-07-26 11:57:53 +08:00
Cheng Zhao
72eb87a631 Make the extraSize of BrowserWindow.setAspectRatio optional 2015-07-23 10:14:02 +08:00
Cheng Zhao
ea1b89c699 Merge pull request #2250 from EyeSee360/master
Maintain an aspect ratio for content within a window
2015-07-23 09:45:42 +08:00
Michael S. Barthelemy
6d25c81bd1 changes requested for pull request #2250 into electron master 2015-07-22 10:23:31 -04:00