Commit graph

2304 commits

Author SHA1 Message Date
Daniel Pereira
f4d3c169b0 📝Update documentation desktopCapturer to javascript[ci skip] 2017-05-15 13:45:14 -05:00
Daniel Pereira
37bcc96e95 📝Update constraints for audio sharing[ci skip] 2017-05-15 13:42:47 -05:00
Daniel Pereira
e38e294be3 📝Update use of deprecated getUserMedia[ci skip] 2017-05-15 13:38:32 -05:00
Kevin Sawicki
c7e6cbcf9f Merge pull request #9435 from electron/disk-cache-size-flag
support --disk-cache-size flag
2017-05-15 11:09:38 -07:00
Birunthan Mohanathas
a1e826e405 Fix copy paste typos in BrowserView docs 2017-05-15 21:09:11 +03:00
Alexandre Lachèze
77bf4c8ebb 📝 document getOSProcessId() 2017-05-15 20:02:20 +02:00
Kevin Sawicki
b4fc50e3b2 Doc --disk-cache-size 2017-05-15 10:38:20 -07:00
Samuel Attard
d84ddd7fe4 Fix createFromDataURL return type
Fixes #9469
2017-05-16 01:24:06 +10:00
Birunthan Mohanathas
0153731888 Make docs for webview.findInPage and webContents.findInPage consistent 2017-05-14 13:43:42 +03:00
Birunthan Mohanathas
5cfa697309 Fix postData type definition in docs 2017-05-14 13:43:38 +03:00
Kevin Sawicki
190c9c916e Merge pull request #9331 from 22222/issue2579
Add 'will-prevent-unload' event for #2579.
2017-05-11 09:04:40 -07:00
Kevin Sawicki
4e1943dfe6 Minor updates to example
* const-ing
* mainWindow -> win
* add dialog require
2017-05-11 09:01:51 -07:00
Samuel Attard
f57c1881da
Fix return type of makeSingleInstance 2017-05-11 22:09:37 +10:00
22222
4044548f3e Add 'will-prevent-unload' event. 2017-05-11 06:35:35 -05:00
Ryohei Ikegami
7ac93045b7 Merge branch 'master' into native-window-open 2017-05-11 13:51:43 +09:00
Kevin Sawicki
6ca7787f13 Merge pull request #9427 from electron/fix-docs-6
Fix webcontents capital
2017-05-10 16:30:04 -07:00
Samuel Attard
b4e356212c Fix webcontents capital 2017-05-11 09:28:24 +10:00
Kevin Sawicki
f46b383824 Add types 2017-05-10 14:29:57 -07:00
Kevin Sawicki
a44f0620b3 : -> - 2017-05-10 14:27:51 -07:00
Kevin Sawicki
edac443673 Correct property name to pid 2017-05-10 14:26:13 -07:00
Hari Juturu
277c3155a6 use will-create-webview event 2017-05-09 10:12:44 -07:00
renaesop
cba5e96496 Merge remote-tracking branch 'ups/master' 2017-05-09 09:44:24 +08:00
Hari Krishna Reddy Juturu
3321f7d39c Changing command line option name 2017-05-08 17:27:31 -07:00
Tom Watson
50057163c6 📝 clarify dialog buttons blocking side effect 2017-05-08 11:17:33 +02:00
Brian Zelip
68c19fc509 📝 minor docs copy edit - add two words
[ci skip]
2017-05-07 11:06:46 -04:00
Hari Krishna Reddy Juturu
94d054cf11 Add option to override webview security 2017-05-06 22:10:42 -07:00
Hari Krishna Reddy Juturu
b4a8ed01f1 PR 44648: Enabling creation on webview with node-integration disabled and raising events
- Enabling creation on webview with node-integration disabled and raising events

Conflicts:
	lib/browser/guest-view-manager.js
2017-05-06 20:50:01 -07:00
Hari Krishna Reddy Juturu
472dad1ffc convert var to const 2017-05-04 14:33:59 -07:00
Hari Krishna Reddy Juturu
8bc4d3f8bd GetIOCounters is not implemented on mac 2017-05-04 14:33:59 -07:00
Hari Krishna Reddy Juturu
8a5aa04756 Adding CPU and I/O metrics to process module 2017-05-04 14:33:59 -07:00
Kevin Sawicki
eebae82bc1 Merge pull request #9315 from electron/segmented-control-mode
Add mode prop to segmented touch bar control
2017-05-04 14:16:28 -07:00
Kevin Sawicki
01b3db3d2f 🎨 2017-05-04 14:15:48 -07:00
Kevin Sawicki
59511354fd Merge pull request #9214 from electron/app-memoryinfo
API to get memory of all processes of the app
2017-05-04 14:00:30 -07:00
Kevin Sawicki
edd28c9a91 Link to MemoryInfo structure 2017-05-04 13:35:12 -07:00
Kevin Sawicki
0343db53ad Merge pull request #9344 from rafbm/patch-1
Use actual Chromium l10n_util list in locales.md
2017-05-04 11:31:31 -07:00
Kevin Sawicki
c59fab0179 Merge pull request #9242 from shiftkey/certificate-addition-windows
certificate trust API for Windows
2017-05-03 16:39:00 -07:00
Samuel Attard
718dc732ad
Add docs and add isSelected arg 2017-05-03 20:25:50 +10:00
Kevin Wojniak
342a8fd577 Add missing word 2017-05-02 09:05:07 -07:00
Rafael Masson
410078bb54 Use actual Chromium l10n_util list in locales.md
I’m not sure where the locale list from the [original commit](bbaab9b355) came from, but it clearly wasn’t copied from `l10n_util`. It was missing Spanish, Portuguese, Polish, Vietnamese, to name a few…

This commit overwrite the whole list with [`l10n_util` as-is](61cfc2b0a8/ui/base/l10n/l10n_util.cc (L41-L175)).
2017-05-01 17:15:37 -04:00
Brendan Forster
541efc3b93 tidy up docs 2017-04-29 19:35:49 +10:00
Kevin Sawicki
c26605c384 Minor edits to example guide 2017-04-27 14:22:56 -07:00
Hari Krishna Reddy Juturu
27aad902b8 Adding docs, specs and fixing object returned 2017-04-27 14:06:53 -07:00
Hari Krishna Reddy Juturu
bef7d5a520 API to get memory of all processes of the app 2017-04-27 14:06:53 -07:00
Neil Craig
c0669cb46e Update touch-bar.md
Add a simple example of running the example code as it might not be obvious to people who've not used Electron. Hopefully it makes sense :-)
2017-04-27 20:19:17 +01:00
Brendan Forster
5534181ebd rework docs 2017-04-27 15:12:30 +10:00
Brendan Forster
50af70a0e8 Merge branch 'master' into certificate-addition-windows 2017-04-27 14:47:50 +10:00
Ryohei Ikegami
1d73e84a29 Merge branch 'master' into native-window-open 2017-04-27 12:03:55 +09:00
Kevin Sawicki
f6bbcc6efa Fix typos 2017-04-26 13:03:15 -07:00
Kevin Sawicki
87db1b8aa7 Document other inherited web preferences 2017-04-25 12:57:53 -07:00
Kevin Sawicki
7881376aff Merge pull request #9254 from electron/endsession-event
End session event on browser window
2017-04-24 12:02:05 -07:00
Hari Krishna Reddy Juturu
9e70372c1f change endsession event name to session-end 2017-04-24 10:16:11 -07:00
Kevin Sawicki
d3ae1d8d23 Merge pull request #9246 from rreimann/master
Clarify requirements for resumable downloads
2017-04-24 08:50:55 -07:00
Kevin Sawicki
13eeb1d17f Minor wording tweaks 2017-04-24 08:50:40 -07:00
Kevin Sawicki
99985c0ed9 Wrap header names in backticks 2017-04-24 08:49:59 -07:00
Brendan Forster
253a4b0114 Merge remote-tracking branch 'electron/master' into certificate-addition-windows 2017-04-24 11:13:34 +10:00
rreimann
7ea6d01a8c Rephrase note for resume method 2017-04-22 18:15:07 +02:00
Hari Krishna Reddy Juturu
3c3e14b820 End session event on browser window 2017-04-21 14:22:11 -07:00
Kevin Sawicki
e9880e9c97 Merge pull request #8996 from swashcap/master
Add documentation note on dynamic Menu items
2017-04-21 13:44:01 -07:00
Kevin Sawicki
7177ea5e9a Bold note for emphasis 2017-04-21 13:39:51 -07:00
rreimann
7ce3571270 Clarify requirements for resumable downloads 2017-04-21 15:14:56 +02:00
Brendan Forster
304c8b9562 add some docs for Windows usage 2017-04-21 13:09:49 +10:00
Paul Frazee
3068d7a43e Make note about sync webview calls in docs 2017-04-20 14:02:41 -05:00
Kevin Sawicki
dc8b43901b Merge pull request #9108 from yuya-oc/add-macos-sheet-events
Add sheet-begin and sheet-end events to macOS BrowserWindow
2017-04-20 10:33:31 -07:00
Kevin Sawicki
6701a96216 Merge pull request #9211 from sindresorhus/patch-1
Add docs tip about testing Touch Bar usage
2017-04-18 12:10:45 -04:00
Hari Krishna Reddy Juturu
efca0a6e07 fixup! Adding cookie flush store api 2017-04-18 09:05:13 -07:00
Hari Krishna Reddy Juturu
19709a50e9 Adding cookie flush store api 2017-04-18 09:05:13 -07:00
Samuel Attard
11c7c107a9 add iconPosition property to touch bar buttons 2017-04-18 08:56:39 -07:00
Ryohei Ikegami
8dff29185b Merge branch 'master' into native-window-open 2017-04-18 21:59:22 +09:00
Sindre Sorhus
39caa6ad23 📝 Add docs tip about testing Touch Bar usage
Disclosure: I made it.

Most devs don't have the new MacBook with Touch Bar, but would like to support it. I think it would be useful to point out how to easily develop and test Touch Bar usage in Electron apps.

[ci skip]
2017-04-17 14:39:37 +07:00
Yuya Ochiai
75184046f6 Add events to manage sheets of macOS BrowserWindow 2017-04-15 16:26:45 +09:00
Birunthan Mohanathas
e7d71000ee Fix missing warning icon with dialog.showMessageBox() on macOS
Fixes #9183.
2017-04-14 19:27:25 +03:00
Birunthan Mohanathas
000aedf2e7 Avoid insecure nodeIntegration in example 2017-04-13 01:27:31 +03:00
Birunthan Mohanathas
06fcf2c19d Add support for BrowserView autoresizing 2017-04-13 01:27:31 +03: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
Kevin Sawicki
0caa35d33c Merge pull request #9155 from Hum4n01d/master
Add information about dragging not working with Dev tools open
2017-04-10 08:18:09 -07:00
Kevin Sawicki
676f02e001 Tweak GitHub spelling 2017-04-10 08:17:55 -07:00
Kevin Sawicki
3ec7900e6e Merge pull request #9154 from miniak/fix-api-docs
Fix api docs
2017-04-10 08:16:54 -07:00
Hum4n01d
0ce983363b Add information about dragging not working with Dev tools open 2017-04-09 23:05:56 -07:00
Milan Burda
fa0de5c2b4 Define filter argument type for WebRequest methods 2017-04-10 02:18:36 +02:00
Milan Burda
8f46137fda Fix session.setPermissionRequestHandler webContents argument type 2017-04-10 02:12:15 +02:00
Kevin Sawicki
b7b7f28c5a Link properties to class docs 2017-04-08 18:50:55 -07:00
Tasuku Uno
59fe7d3dbb 📝 Fix document of MimeTypedBuffer Object
[ci skip]
2017-04-06 11:38:59 +09:00
Kevin Sawicki
414540bfcb Support passing escape item to TouchBar constructor 2017-04-04 12:50:41 -07:00
Kevin Sawicki
b24b4212c5 Make escape item a property instead of setter 2017-04-04 12:50:41 -07:00
Samuel Attard
60cc862031 Make everything pointer like 2017-04-04 12:50:41 -07:00
Samuel Attard
4d6b0fc01b Add a method to set the escape identifier on the touch bar 2017-04-04 12:50:41 -07:00
Kevin Sawicki
3e9014c371 Merge pull request #9099 from electron/certificate-trust
macOS: Add certificate trust API
2017-04-04 11:17:09 -07:00
Kevin Sawicki
2e32525e8f Make browser window optional 2017-04-04 10:49:10 -07:00
Kevin Sawicki
af40a60937 Merge pull request #9072 from p-jackson/patch-1
Document passing null to Menu.setApplicationMenu
2017-04-04 08:42:08 -07:00
joshaber
146e1ed3ce Don't pass the result through
It's meaningless on macOS, at least.
2017-04-04 09:21:15 -04: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
Philip Jackson
6169ccd1e2 📝 Document that setApplicationMenu(null) has no effect on macOS 2017-04-04 18:00:20 +12:00
joshaber
e2bda3ca0f Use an options object for most of the params 2017-04-03 21:33:21 -04:00
joshaber
da1b0aab3e Flesh out some docs 2017-04-03 15:39:45 -04:00
Samuel Attard
f757912f90
Add missing finalUpdate prop 2017-04-01 12:11:34 +11:00
Kevin Sawicki
6d516fbae3 Move normalizeAccessKeys docs to right method 2017-03-31 15:08:03 -07:00
Thiago de Arruda
f0d447cd68 Pass uploadToServer to windows crash reporter 2017-03-31 13:46:30 -03:00
Philip Jackson
1c80102218 📝 Document passing null to Menu.setApplicationMenu
[ci skip]
2017-03-31 16:42:03 +13:00
Kevin Sawicki
a2588c1fd9 Merge pull request #9052 from tonyganch/native_tabs
Native tabs on macOS
2017-03-30 14:02:19 -07:00
Kevin Sawicki
6f27d466a5 Move tabbingIdentifier out of webPreferences list 2017-03-30 13:49:00 -07:00
Kevin Sawicki
4001ba038e Add descriptions for each segmentStyle 2017-03-30 12:36:20 -07:00
Kevin Sawicki
f805bbee9b Merge pull request #9062 from electron/stringify-headers-in-net-module
Fix net module to accept non-string header values
2017-03-30 12:35:53 -07:00
Zeke Sikelianos
f0e7a84627 Merge pull request #9065 from electron/roles
Improve docs for MenuItem Roles
2017-03-30 12:28:14 -07:00
Thiago de Arruda
b3cf00a19a Fix net module to accept non-string header values
This is required to be compatible with node.js http module.
2017-03-30 16:01:40 -03:00
Kevin Sawicki
3100463117 Merge pull request #8917 from bcomnes/patch-1
Clarify remote require of relative modules
2017-03-30 12:00:47 -07:00
Kevin Sawicki
55bf2239df Remove spaces around brackets 2017-03-30 11:58:09 -07:00
Zeke Sikelianos
d5bc8990fc link to roles list from Menu doc 2017-03-30 11:08:12 -07:00
Zeke Sikelianos
b24be19fac tighten up formatting of menu example 2017-03-30 11:07:59 -07:00
Zeke Sikelianos
d779ecf674 create a linkable heading for MenuItem roles 2017-03-30 11:07:25 -07:00
Colin Eberhardt
bed32682b7 Clarification of the chromium sandbox support 2017-03-30 10:47:14 +01:00
Kevin Sawicki
57edc28b0d Merge pull request #8880 from mst128256/2814
Default menu items for 'Edit' and 'Window' #2814
2017-03-29 12:31:58 -07:00
Tony Ganch
a7565f0d57 Enable native tabs on macOS 2017-03-29 13:51:39 +02:00
deepak1556
8db1eacd1c [skip ci] add docs 2017-03-28 18:46:21 +05:30
Ryohei Ikegami
87565f4c84 Simplify example code 2017-03-28 19:50:45 +09:00
Ryohei Ikegami
e885e33b75 Fix choise -> choice 2017-03-28 19:50:00 +09:00
Kevin Sawicki
ad5a48d255 Merge pull request #8983 from electron/sandbox-initial-documentation
Add initial documentation for `sandbox` option.
2017-03-27 10:16:24 -07:00
Kevin Sawicki
870dcb9071 Remove old sandbox option in list and mark as experimental 2017-03-27 10:14:47 -07:00
Kevin Sawicki
10dc08b39b Merge pull request #9006 from electron/fix-thumbnailSize-doc
fix docs for thumbnailSize
2017-03-27 09:10:40 -07:00
Samuel Attard
168c47bf10 Update web-contents.md 2017-03-25 18:27:43 +11:00
Samuel Attard
b62f1fd022
Add missing return type on executeJavaScript 2017-03-25 14:59:48 +11:00
Samuel Attard
a80148aa29
Add missing property types on the process docs 2017-03-25 14:51:23 +11:00
Samuel Attard
aa5c778ca2
Generic doc fixes 2017-03-25 12:37:07 +11:00
Zeke Sikelianos
095df457b2 fix docs for thumbnailSize 2017-03-24 11:14:43 -07:00
mst128256
9e471d8f1c Added specs 2017-03-24 12:14:08 +01:00
Thiago de Arruda
437f1192d9 Add initial documentation for sandbox option. 2017-03-23 21:42:25 -03:00
Cory Reed
a92f639b64 📝 Add note regarding dynamic addition/removal of menu items.
Closes #8928.

[ci skip]
2017-03-23 11:57:44 -07: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
c3c67f78c1 Improve docs on window.open 2017-03-19 20:33:22 +09:00
Ryohei Ikegami
88f062958f Fix option doc 2017-03-19 20:21:03 +09:00
Ryohei Ikegami
2c21d3b3fa Fix JavaScript in docs 2017-03-19 20:09:52 +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
Kevin Sawicki
3ae034deab Change data -> format in clipboard docs 2017-03-17 09:57:17 -07:00
Kevin Sawicki
466c39ed19 Use icon for consistency with other touch bar APIs 2017-03-15 09:33:11 -07:00
Kevin Sawicki
87c219748d Document more constructor options 2017-03-14 14:12:41 -07:00
Kevin Sawicki
2e0e4e69bb Drop on prefix from property names 2017-03-14 14:02:48 -07:00
Bret Comnes
b67c81226c
fix linting 2017-03-14 10:48:44 -07:00
Samuel Attard
a55cddaa53
Add more options 2017-03-14 18:57:57 +11:00
Bret Comnes
85c48a2336
make main process example shorter 2017-03-13 17:20:11 -07:00
Bret Comnes
2276357f72
update with a tree 2017-03-13 17:18:23 -07:00
Bret Comnes
f82590b9ab Wrap at 80 2017-03-13 15:48:42 -07:00
Bret Comnes
46af3cefec Clarify remote require of relative modules
The docs for the `remote.require(module)` method were a little too terse for me to understand the behavior of relative module loading for `remote.require` and I had to run an experiment to understand the behavior (e.g. is the relative path relative to caller of `remote.require` or relative to some other path in the project related to the main process?).   I think this is correct but someone please double check my understanding.

Adding an example and additional explanation should help clarify this.  Feel free to edit the copy as needed.
2017-03-13 15:42:26 -07:00
Samuel Attard
cfb3798703
Add docs for TouchBarScrubbber 2017-03-13 11:00:25 +11:00
Samuel Attard
e6a66b6006
Add docs for segmented control touch bar item 2017-03-10 17:50:23 +11:00
Thiago de Arruda
e03e37e984 Pass uploadToServer parameter to linux crash reporter 2017-03-09 17:23:52 -03:00
Kevin Sawicki
f19998ef4c Add more default values 2017-03-09 10:26:44 -08:00