Commit graph

2476 commits

Author SHA1 Message Date
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
Michael Kaylan
b4428e7e41 🍎 Add macOS native tab methods to window API 2017-08-21 23:24:30 -04:00
Charlie Hess
f17bd040ad Merge pull request #10293 from electron/notification-sounds
Add support for soundName in main process notifications
2017-08-21 16:15:47 -07:00
Zeke Sikelianos
b1011768e5 Merge pull request #10251 from electron/new-update-docs
New guide for implementing updates
2017-08-21 15:22:43 -07:00
Charlie Hess
f2c0d1f0c5
📝 Little cleanup. 2017-08-21 13:56:10 -07:00
Charlie Hess
db081d95d5
Review CommentZ. 2017-08-21 13:53:50 -07:00
Siyuan Liu
eeb2e58ad8 return null when theme color is not found 2017-08-20 22:48:13 +08:00
Mathieu Débit
81f7b422e4 📝 Fix desktopCapturer example (#10303)
[ci skip]

Based on MDN example:
https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#Examples
2017-08-18 22:02:28 +02:00
Cheng Zhao
ac6a44f0ac Merge pull request #10273 from rhysd/doc-fix-optional-args
fix some optional args docs
2017-08-18 19:07:56 +09:00
Charlie Hess
2b9b186fd1
Rename soundName → sound. 2017-08-17 17:28:14 -07:00
Charlie Hess
0cfae1cc2b
Plumb in the macOS soundName property for notifications. 2017-08-17 13:31:20 -07:00
rhysd
01f549628f fix signature of <webview>.executeJavaScript 2017-08-17 17:06:30 +09: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
Cheng Zhao
f908678e8e Merge pull request #10183 from andens/mouse_forward
Mouse forward functionality on Windows
2017-08-17 15:54:22 +09:00
Andreas Flöjt
d4bbd7c7ab Add example of using mouse forwarding. 2017-08-16 03:28:52 +02:00
rhysd
2edf4da859 fix some optional args docs 2017-08-16 02:23:36 +09:00
Michael Kaylan
7741a0e6ad 🍎 Add roles for macOS native tab menu items
Fixes #9086, #10064.
2017-08-15 11:30:39 -04:00
Leo Lamprecht
78f11df6e4 Full Windows section is back 2017-08-15 11:27:33 +02:00
Leo Lamprecht
3405596983 Brought back Windows section 2017-08-15 11:24:59 +02:00
renaesop
6d16eb81d2 Add a callback option to webContents.print 2017-08-15 14:44:24 +08:00
Andreas Flöjt
3d33da7696 Make mouse forward option of setIgnoreMouseMessages and update documentation. 2017-08-14 20:21:00 +02:00
Zachary Flower
8a2c35023f 📝 Document simple fullscreen functionality [ci skip] 2017-08-13 00:58:28 -06:00
Leo Lamprecht
01f31edb95 Cut down platform notices a little 2017-08-12 01:30:29 +02:00
Leo Lamprecht
c1a40fbd98 Linked guide about implementing updates 2017-08-12 01:10:20 +02:00
Zeke Sikelianos
d0130e1b09 Merge pull request #9988 from kant2002/patch-1
Allow TypeScript definitions work with strictNullChecks
2017-08-07 20:37:26 -07:00
John Kleinschmidt
ccdff72ee4 Merge pull request #9918 from alexstrat/add-extensions-loading-api
Introduce Chrome extensions management APIs independent of Dev Tools Extensions
2017-08-07 20:06:22 -04:00
Andreas Flöjt
12dbcfa2ea 📝 Documentation for setForwardMouseMessages. 2017-08-02 21:50:42 +02:00
Birunthan Mohanathas
20ae611dd9 Merge pull request #10097 from liusy182/liusy182-browserview
#10039 add BrowserView.fromId
2017-07-28 01:27:47 +03:00
Dustin
bdc7d38f48 Removed mention of SegmentedControl in description 2017-07-27 07:51:19 +02:00
Zeke Sikelianos
1811b0cbda fix heading levels for class docs 2017-07-26 13:02:40 -07:00
Zeke Sikelianos
ac248e79a4 Merge pull request #10113 from lsegal/patch-1
Mark certain Notification options as optional
2017-07-25 17:04:13 -07:00
Loren Segal
205954fa27 Mark certain Notification options as optional
This change makes the `subtitle` and `actions` options optional to the
Notification constructor, since they are only available on macOS.
2017-07-25 13:24:15 -04:00
Fabian Zeindl
5db02ffaa9 updates to the docs 2017-07-24 10:29:45 +02:00
Cheng Zhao
cb3c5ded0f Merge pull request #9975 from wayne-kim/patch-5
this code is not care a bubbling event
2017-07-24 16:07:44 +09:00
Siyuan Liu
ae7c1ae741 #10039 add BrowserView.fromId 2017-07-24 11:32:30 +08:00
Kevin Sawicki
959231f766 Merge pull request #9834 from shubham2892/input-type-file-treating-packaged-app-as-directory
Fix treat packaged app as directory
2017-07-18 10:21:07 -07:00
Kevin Sawicki
7db3009234 Remove s 2017-07-18 10:19:00 -07:00
Kevin Sawicki
908c1fdfa0 Mark treatPackageAsDirectory as mac only 2017-07-18 10:18:23 -07:00
Shubham
b25a1d10a2 🍎 Add treatPackageasDirectory as an option 2017-07-18 10:13:25 -07:00
Kevin Sawicki
a2554080ea Mark nativeWindowOpen as experimental 2017-07-17 12:40:59 -07:00
Kevin Sawicki
0b13ccac34 Merge pull request #9855 from electron/paulcbetts-patch-1
Recommend electron-forge in auto-updater, fix some Windows stuffs
2017-07-14 14:33:39 -07:00
Kevin Sawicki
5581d1d652 Merge pull request #9788 from shubham2892/Add-option-to-show-title-text-in-titlebar-in-fullscreen
Add alwaysShowTitleTextInFullscreen flag
2017-07-14 11:58:12 -07:00
Kevin Sawicki
9102c07ec7 always_show_title_text_in_full_screen -> fullscreen_window_title 2017-07-14 11:48:10 -07:00
Kevin Sawicki
48f5a66f87 Merge pull request #9983 from electron/devtools-mixed-sandbox
Fix devtools open in mixed sandbox
2017-07-14 09:41:56 -07:00
Birunthan Mohanathas
812b529881 Add app.disableDomainBlockingFor3DAPIs()
By default, Chromium disables 3D APIs (e.g. WebGL) until restart on a
per domain basis if the GPU processes crashes too frequently. This
function disables that behaviour.
2017-07-14 01:41:43 +03:00
Andrey Kurdyumov
189be18dd2 Allow TypeScript definitions work with strictNullChecks
See https://github.com/electron/electron-typescript-definitions/issues/25
2017-07-12 20:29:32 +06:00
Hari Juturu
9a3b78d9fe Fix devtools open in mixed sandbox mode 2017-07-11 18:36:00 -07:00
Wayne Loopy
bc0f3b1bf8 this code is not care a bubbling event
So If you do not care bubbling equally, I think it should change like this.
2017-07-11 15:44:08 +09:00
Alexandre Lachèze
f09e448d4d 📝 2017-07-05 17:01:30 +02:00
Amos Wenger
bd8459841b 📝 mixed devtools behavior with mixed sandbox 2017-07-04 14:20:18 +02:00
Milan Burda
a196bf97bc 🍎 Add subtitle to Notification properties 2017-06-30 16:54:28 +02:00
Kevin Sawicki
e37fc0e30a Mark mixed sandbox as macOS/Windows only 2017-06-28 14:36:34 -07:00
Kevin Sawicki
0f83180377 Merge pull request #9837 from electron/notification-actions
Notification actions
2017-06-28 12:59:10 -07:00
Kevin Sawicki
e44f655503 Merge pull request #9760 from shubham2892/Add-mouse-enter-and-mouse-exit-event-for-Tray
Add mouse-enter and mouse-exit events for tray
2017-06-28 12:15:32 -07:00
Kevin Sawicki
70544440f9 Add location and keyboard modifiers to tray mouse events 2017-06-28 12:10:24 -07:00
Kevin Sawicki
2406d6c279 Rename to mouse-leave for consistency with drag-leave 2017-06-28 11:40:21 -07: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
Kevin Sawicki
2cd49f3036 Merge pull request #9644 from electron/webview-sandbox
Enable sandbox on webview
2017-06-28 10:10:25 -07:00
Kevin Sawicki
f1dbfb1925 Mark app.enableMixedSandbox() as experimental 2017-06-28 08:36:29 -07:00
Kevin Sawicki
f0ec9c68b0 Merge pull request #9883 from electron/ipc-return-value
document the return value of ipcRenderer.sendSync
2017-06-28 08:03:27 -07:00
Zeke Sikelianos
f646be2981 document the return value of ipcRenderer.sendSync 2017-06-27 12:01:39 -07:00
Zeke Sikelianos
d3ac9a3f3b fix crash reporter typo 2017-06-27 10:40:14 -07:00
Hari Krishna Reddy Juturu
74196b96a1 Adding enableMixedSandbox api 2017-06-26 14:13:41 -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
Kevin Sawicki
a916be3ffd Merge pull request #9754 from t-hofmann/patch-1
Create app.md
2017-06-26 08:53:44 -07:00
Kevin Sawicki
da001940e2 isNotFirstInstance -> isSecondInstance 2017-06-26 08:53:29 -07:00
Kevin Sawicki
3804bc5eb2 Merge pull request #9847 from timfish/patch-1
Fixes electron/electron-typescript-definitions/issues/63
2017-06-26 08:50:49 -07:00
Kevin Sawicki
43f7e42bf7 Mark silent/printBackground as optional 2017-06-26 08:50:00 -07:00
Kevin Sawicki
ef38122388 Merge pull request #9778 from lepinay/patch-1
Extra properties must be less than 63 characters
2017-06-26 08:36:43 -07:00
Kevin Sawicki
cbaf3d4787 Tweak character limit description 2017-06-26 08:35:57 -07:00
Birunthan Mohanathas
79e9926f40 Merge pull request #9826 from ccnokes/patch-1
Fix docs: app.md `setLoginItemSettings`
2017-06-26 08:07:15 -07:00
Cheng Zhao
00d023cd71 Merge pull request #9725 from danielma/dma/native-tab-new-button
Add "New Tab" button for Native macOS Tabs
2017-06-26 15:07:10 +09:00
Paul Betts
97a9708c03 Recommend electron-forge in auto-updater, fix some Windows stuffs
We should point people to electron-forge, it's the modern way to package Electron apps
2017-06-25 22:10:48 -07:00
Tim Fish
58a42682d8 Fixes electron/electron-typescript-definitions/issues/63 2017-06-25 10:43:47 +02:00
Samuel Attard
b8be81f101 Fix structure docs 2017-06-24 00:30:13 +10:00
Samuel Attard
17e737eba2 s/label/text 2017-06-23 21:04:39 +10:00
Samuel Attard
96f9dba595 Document the reply / button compatibility state 2017-06-23 20:56:55 +10:00
Samuel Attard
a9bf9d26ab Fix typo in Notification docs 2017-06-23 20:50:50 +10:00
Samuel Attard
4f0d48f164 Add support for notification actions on macOS 2017-06-23 20:50:20 +10:00
Cameron Nokes
3239da37dd Fix docs: app.md setLoginItemSettings
`app.setLoginItemSettings` documented arguments are misleading -- `path` and `args` should be passed in the `settings` object, not as separate params, like the code sample below it or in the test file here: 9250b559f9/spec/api-app-spec.js (L336)
and in the actual C++ function declaration here: f5a75c4e87/atom/browser/browser.h (L104)
2017-06-21 16:24:00 -06:00
John Kleinschmidt
a4e0af2fbf Updated referenced command line flag. 2017-06-21 15:01:55 -04:00
John Kleinschmidt
671f5c20f7 Add process properties in lieu of command line options.
Resolves #9139
For certain node command line options, those options can be set via the
process object (process.noDeprecation, process.throwDeprecation,
process.traceDeprecation, and process.traceProcessWarnings) so they are
documented here.

Also, sorted properties and methods alphabetically for easier
readability.
2017-06-21 14:58:44 -04:00
Hari Krishna Reddy Juturu
cf392e402c Adding docs 2017-06-19 11:21:31 -07:00
Shubham
25c651c40a add alwaysShowTitleTextInFullscreen flag 2017-06-17 20:45:29 -04:00
foo bar code
4bed743417 Extra properties must be less than 63 characters
I found out that after trying to putting some long text in my extra properties that it was truncated, digging around I found these:

897d58bde1/atom/common/crash_reporter/crash_reporter_win.cc
const int kNameMaxLength = 64;
const int kValueMaxLength = 64;
2017-06-16 14:41:12 +02:00
Birunthan Mohanathas
ece50c036d Document webContents.focus() 2017-06-15 10:19:27 -07:00
Kevin Sawicki
e94698d7cd Merge pull request #9751 from electron/optional-spelling
use lowercase for optional annotation
2017-06-15 10:12:15 -07:00
Zeke Sikelianos
7587fc22f1 Merge pull request #9724 from electron/bump-standard-markdown
Bump standard-markdown
2017-06-14 17:26:53 -07:00
Shubham
8dbb8ccbab add mouse-enter and mouse-exit events for tray 2017-06-14 18:00:29 -04:00
Kevin Sawicki
dae27de504 Merge pull request #9588 from electron/poiru/dialog-default-file-name
Use last selected directory when using default file name in dialog.showSaveDialog()
2017-06-14 14:41:45 -07:00
Thomas Hofmann
1a6f6fd497 Create app.md 2017-06-14 12:12:30 +02:00
Zeke Sikelianos
56ee50f3a3 use lowercase for optional annotation 2017-06-13 13:50:10 -07:00
Zeke Sikelianos
b328a238a6 Merge pull request #9750 from electron/path-csd-props
Make clearStorageData options object's property optional
2017-06-13 13:48:10 -07:00
Vanessa Yuen
cd28bdd815 add integer note to each parameter 2017-06-13 11:51:55 -07:00
Samuel Attard
de066b8d13 Make clearStorageData options object's property optional
Fixes #9749
2017-06-14 04:34:13 +10:00
Daniel Ma
4fb9f825b1 Add "New Tab" button for Native macOS Tabs
Adds responders for `newWindowForTab` to `AtomApplicationDelegate` and
`NativeWindowMac`, so that `BrowserWindow`s with a `tabbingIdentifier`
will get the new tab button, and both `app` and `window` will emit a
`new-tab-for-window` event.
2017-06-11 02:26:26 -07:00
Zeke Sikelianos
3d2c622ba7 use new Buffer.from 2017-06-10 12:22:27 -07:00
Brian Fajardo
1f73942922 Update rectangle.md (issue #9552)
Clear confusion regarding rectangle object parameter values
2017-06-09 17:13:57 -04:00
Kevin Sawicki
206bca52b7 Merge pull request #9706 from KagamiChan/master
📝  add notes for peak working set size on macOS
2017-06-09 08:43:06 -07:00
Zeke Sikelianos
6360576d9e link to cookie structure 2017-06-08 10:09:40 -07:00
Kagami
a702f8a5f5 add peak working set size comment 2017-06-09 01:05:53 +08:00
Samuel Attard
dd394b0d5c Fix typings for cookies.get 2017-06-08 23:03:57 +10:00
Zeke Sikelianos
0732329a38 Merge pull request #9599 from electron/fix-type-defs
Fix type definitions for getCPUUsage / getIOCounters
2017-06-07 09:21:46 -07:00
Birunthan Mohanathas
7d2226e05e Let Chromium manage document.visibilityState and document.hidden
Chromium already includes the necessary plumbing to manage the
visibility properties and `visibilitychange` event so this gets rid of
most of our custom logic for `BrowserWindow` and `BrowserView`.

Note that `webview` remains unchanged and is still affected by the issues
listed below.

User facing changes:

- The `document` visibility properties and `visibilitychange` event are
  now also updated/fired in response to occlusion changes on macOS. In
  other words, `document.visibilityState` will now be `hidden` on macOS
  if the window is occluded by another window.

- Previously, `visibilitychange` was also fired by *both* Electron and
  Chromium in some cases (e.g. when hiding the window). Now it is only
  fired by Chromium so you no longer get duplicate events.

- The visiblity state of `BrowserWindow`s created with `{ show: false }`
  is now initially `visible` until the window is shown and hidden.

- The visibility state of `BrowserWindow`s with `backgroundThrottling`
  disabled is now permanently `visible`.

This should also fix #6860 (but not for `webview`).
2017-06-06 15:16:01 -07:00
Kevin Sawicki
1adc94b650 Mention customButtonsOnHover is for frameless windows 2017-06-05 14:18:08 -07:00
Kevin Sawicki
d5dc849c7a Doc customButtonsOnHover in frameless window guide 2017-06-05 14:16:44 -07:00
Kevin Sawicki
41d582f689 Add back hidden-inset as a deprecated option 2017-06-05 14:16:23 -07:00
Kevin Sawicki
594302fcff Update docs to use hiddenInset 2017-06-05 14:07:57 -07:00
Kevin Sawicki
7d10bf229d Switch to titleBarStyle for custom window buttons on hover 2017-06-05 13:30:32 -07:00
Kevin Sawicki
410e5bce60 Document customWindowButtons option 2017-06-05 13:04:17 -07:00
Kevin Sawicki
9a362eed53 Merge pull request #9572 from shubham2892/api-height-menubar-macos
API height menubar macos
2017-06-05 10:35:16 -07:00
Kevin Sawicki
653ef6f839 🎨 2017-06-05 10:33:46 -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
Kevin Sawicki
fb47dc9e48 🎨 2017-06-05 08:55:42 -07:00
Rajat
2df7680d24 Docs: Add requirement for webContents.sendInputEvent() to work. 2017-06-03 23:47:15 +05:30
Samuel Attard
af09d85125 Update menu.md 2017-06-03 14:50:10 +10:00
Kevin Sawicki
b964c304de Add return type to systemPreferences.isAeroGlassEnabled() 2017-05-31 10:34:14 -07:00
Kevin Sawicki
9250b559f9 Merge pull request #9623 from miniak/gpu-info
Add app.getGPUFeatureStatus
2017-05-31 08:11:50 -07:00
Cheng Zhao
e82af41591 Merge pull request #9269 from electron/main-notifications
Notifications from the main process
2017-05-31 17:21:05 +09:00
Milan Burda
0ecfb4e2f8 Add app.getGPUFeatureStatus 2017-05-30 20:35:14 +02:00
Samuel Attard
3938373ecb
Fix linting errors and add isSupported 2017-05-30 20:27:24 +10:00
Samuel Attard
5048425e6e
Update implementation as per feedback 2017-05-30 19:06:51 +10:00
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
Samuel Attard
6cdfb43e4e Emit a close event 2017-05-29 21:33:43 +10:00
Zeke Sikelianos
116403ed03 remove electron prefix 2017-05-26 15:57:39 -07:00
Charlie Hess
49f76b8bc3 Add Electron prefixes. 2017-05-26 15:56:54 -07:00
Charlie Hess
b88327e025 Type definitions for getCPUUsage / getIOCounters 2017-05-26 15:56:54 -07:00
Kevin Sawicki
b9a25113a6 Add backticks to Object 2017-05-26 14:04:28 -07:00
Kevin Sawicki
b0d4bf81a0 Add backticks around return types 2017-05-26 13:58:14 -07:00
Kevin Sawicki
385d6faf1a Remove options to appease typescript definitions 2017-05-26 13:33:09 -07:00
Kevin Sawicki
dcb22d34b5 Mark deviceName as optional 2017-05-26 13:33:03 -07:00
Kevin Sawicki
8f22e6a265 Add webview example to nativeWindowOpen docs 2017-05-26 10:10:36 -07:00
Kevin Sawicki
6c520a5f40 Fix typo in option name 2017-05-26 10:10:36 -07:00
Kevin Sawicki
9137a2279a Merge pull request #9486 from electron/child-observer
Adding CPU & Memory metrics for App
2017-05-26 09:28:22 -07:00
Kevin Sawicki
cabcd0ef8f Fix typos in ProcessMetric doc 2017-05-26 08:36:51 -07:00
Kevin Sawicki
b5879b7399 🎨 Minor formatting/doc changes 2017-05-26 07:51:17 -07:00
Birunthan Mohanathas
19555bbab2 Use last selected directory when using default file name in dialog.showSaveDialog()
Prior to this change, attempting to use
`dialog.showSaveDialog({ defaultPath: 'foo.png' })` would open the save
dialog to the current directory with the default file name set to
`foo.png`. We now use the last selected directory instead of the current
directory.

Absolute paths are not affected by this change.
2017-05-26 02:18:23 +03:00
Jan Němeček
1b96f66541 Update webview-tag.md
Spelling correction.
2017-05-25 13:32:20 +02:00
Hari Juturu
939747945e Adding CPU & Memory metrics for App 2017-05-24 21:07:35 -07:00
Rajat
ec6eb74ccc Docs: Remove optional parameter for removeAllListeners.
Fixes #9277
2017-05-25 00:36:14 +05:30
Shubham
793d5fd191 🎨 Fix documentation 2017-05-23 23:27:55 -04:00
Shubham
ec0e33e258 Add mac_os tag to documentation 2017-05-23 22:39:54 -04:00
Shubham
b2f1cdfbae Add API to get top bar height on macOS 2017-05-23 22:24:56 -04:00
Kevin Sawicki
5adf9c47fc Remove buffers option since only a single is supported 2017-05-22 13:49:26 -07:00
Ryohei Ikegami
fd313ad578 Tweak doc text 2017-05-22 13:43:21 -07:00
Ryohei Ikegami
f2471cb1b7 Rename buffer -> buffers 2017-05-22 13:43:21 -07:00