Commit graph

483 commits

Author SHA1 Message Date
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