Commit graph

2542 commits

Author SHA1 Message Date
Kevin Sawicki
d1876aa313 Add headings for each module 2016-09-08 09:09:49 -07:00
Kevin Sawicki
25f5135134 Move breaking changes doc to /docs 2016-09-08 09:07:58 -07: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
Charlie Hess
80f046c8df Update docs. 2016-09-03 12:03:58 -07:00
Milan Burda
9911e60f5b Add support for titleBarStyle: 'hidden-inset' on OS X 10.9 2016-09-03 01:33:20 +02:00
Mark Lee
38e1a24304 📝 Make arch references more consistent
[ci skip]
2016-09-01 07:53:32 -07:00
Mark Lee
00154c7f9c 📝 Add missing words
[ci skip]
2016-09-01 07:49:36 -07:00
Cheng Zhao
14f625d61b Merge pull request #6826 from enlight/set-jump-list
Extend the custom Jump List API provided by Electron
2016-09-01 15:35:21 +09:00
deepak1556
7b85ca0301 create helper class to read blob data 2016-09-01 08:52:44 +05:30
Vadim Macagon
c64294cf60 Extend the custom Jump List API
Add `app.getJumpListSettings()` and `app.setJumpList(callback)` that
make it possible to fully customize the Jump List of an Electron app.
It is now possible to:
- Add tasks to the standard `Tasks` category.
- Add separators to the standard `Tasks` category.
- Add custom categories containing tasks and file links.
- Add system managed Recent/Frequent categories.
- Remove the custom Jump List.
2016-09-01 09:56:14 +07:00
deepak1556
be4bc6b7ef fix docs and update specs 2016-09-01 01:01:52 +05:30
deepak1556
a23e7ecf8f add docs 2016-09-01 01:01:52 +05:30
roderik
1ff58a6066 documents webContents.fromId 2016-08-30 22:25:04 -05:00
Cheng Zhao
e2d70fb92b Merge pull request #7028 from electron/default-exit-code
Default app exit code to 0
2016-08-30 19:36:03 +09:00
Samuel Attard
adf9acc468
Default app exit code to 0 2016-08-30 13:30:56 +10:00
Menci
ec60c149f5 Add guide for force new page in print / printToPDF 2016-08-30 08:45:39 +08:00
Zeke Sikelianos
7ff5649965 fix optional param spacing 2016-08-26 23:47:04 -07:00
Kevin Sawicki
307b504eb4 Merge pull request #6925 from BraveNewMath/patch-1
fix windows command prompt error
2016-08-26 14:17:55 -07:00
Kevin Sawicki
8d194691fe Add separate platform examples for running electron 2016-08-26 14:16:30 -07:00
Cheng Zhao
723c74ace6 Merge pull request #6989 from Menci/master
[doc] Add support for titleBarStyle hidden on macOS 10.9
2016-08-26 20:57:26 +09:00
Cheng Zhao
c5ece2bfb1 Merge pull request #6984 from electron/zoom-webview
Document <webview>.setZoomFactor/Level as public
2016-08-26 20:56:47 +09:00
Menci
a9eb6b7238 Add support for titleBarStyle hidden on macOS 10.9
"titleBarStyle: 'hidden'" supports macOS 10.9 now. See https://github.com/electron/electron/pull/6848 and ab8fd49c72 for more info.
2016-08-26 12:06:56 +08:00
Zeke Sikelianos
e91dc83b2c capitalize 2016-08-25 17:26:57 -07:00
Zeke Sikelianos
0ba9564629 use the right bullet 2016-08-25 17:26:52 -07:00
Zeke Sikelianos
ab1238d8fd add a description for BrowserWindowProxy 2016-08-25 15:20:05 -07:00
Kevin Sawicki
bdaea02d8a Document <webview>.setZoomFactor/Level as public 2016-08-25 14:55:01 -07:00
Zeke Sikelianos
5619558689 document some missing parameters 2016-08-25 14:43:06 -07:00
Zeke Sikelianos
0e4e60625f fix method heading level 2016-08-25 14:42:53 -07:00
Zeke Sikelianos
28d42ba35b document missing method parameters 2016-08-25 10:52:19 -07:00
Kevin Sawicki
4ce2c221c9 Minor doc edits and link to MDN page 2016-08-24 09:03:44 -07:00
deepak1556
ae297760af add spec and docs 2016-08-24 06:53:14 +05:30
Kevin Sawicki
1276587ebe Merge pull request #6934 from electron/add-missing-class-descriptions
Give every class a description
2016-08-23 10:16:29 -07:00
Jessica Lord
bb7599cddd Merge pull request #6938 from electron/add-accessibility-doc
Add accessibility doc
2016-08-23 09:30:02 -07:00
Cheng Zhao
4ca6587660 Merge pull request #6935 from electron/default-network-conditions
Default network conditions to 0.0
2016-08-23 16:40:36 +09:00
Zeke Sikelianos
098d4dc0ca improve wording about class instantiation 2016-08-22 21:45:25 -07:00
Jessica Lord
d2ad88978a Add accessibility doc 2016-08-22 16:27:33 -07:00
Zeke Sikelianos
84fc1d022f add missing require to win.loadURL doc 2016-08-22 14:25:48 -07:00
Kevin Sawicki
4fc6cf48b0 Document enableNetworkEmulation defaults 2016-08-22 14:25:42 -07:00
Zeke Sikelianos
3d371e09b7 add a blockquote for every class 2016-08-22 14:11:03 -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
ee44ab7ecd wrap MenuItem constructor in backticks 2016-08-22 11:29:15 -07:00
Zeke Sikelianos
39c5ff2077 missing space in doc 2016-08-22 11:17:05 -07:00
Cheng Zhao
374e23fc37 Merge pull request #6922 from TomKaltz/patch-1
Update devtools-extension.md
2016-08-22 16:52:18 +09:00
Elias
1fe3b70a23 fix windows command prompt error
path to electron needs to be wrapped in quotes or else windows command prompt will error out
2016-08-22 00:29:33 -07:00
Cheng Zhao
23ca9fcd02 Merge pull request #6900 from electron/loadurl-example
Improve doc for loadURL
2016-08-22 10:46:03 +09:00
Cheng Zhao
8b9fd8a76e Merge pull request #6858 from electron/default-protocol-launch-args
Allow settings of launch args when using defaultProtocol
2016-08-22 09:32:54 +09:00
Thomas Kaltz III
77dc700c51 Update devtools-extension.md
Cerebral Debugger is now supported under Electron
2016-08-21 17:36:26 -04: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
Will Eccles
488fe53276 fixed grammar for 32bit 2016-08-18 08:56:12 -07:00
Samuel Attard
ca971e978e
Return boolean instead of empty string when error occurs. Update docs 2016-08-18 18:02:13 +10: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
Kevin Sawicki
6813c03f30 Merge pull request #6853 from electron/about-documentation
Add About Electron documentation
2016-08-17 08:53:33 -07:00
Kevin Sawicki
b8971ae185 Merge pull request #6871 from electron/update-docs-for-electron-npm
Update docs re: electron module update
2016-08-17 08:52:42 -07:00
Kevin Sawicki
09adffe48f Merge pull request #6870 from electron/more-permissive-standard-markdown
Use a more permissive version of standard-markdown
2016-08-17 08:52:06 -07:00
Kevin Sawicki
bc3d2cfc34 Merge pull request #6875 from electron/remove-styleguide-rule-about-endlines
source files DO have newlines at the end
2016-08-17 08:51:20 -07:00
Cheng Zhao
47c37d6f51 Merge pull request #6814 from brave/net-converter-fix
don't convert a string to an array buffer
2016-08-17 20:44:13 +09:00
Zeke Sikelianos
515e25b749 source files DO have newlines at the end 2016-08-16 21:24:53 -07:00
Jessica Lord
3ebd5fbd8f Update docs re: electron module update 2016-08-16 15:57:07 -07:00
Zeke Sikelianos
cc2b95fac3 js → javascript 2016-08-16 14:50:21 -07:00
Zeke Sikelianos
e71280f31c restore js label to orphan code blocks 2016-08-16 14:49:42 -07:00
Zeke Sikelianos
6b298213ab update standard-markdown to 1.2.0 2016-08-16 14:07:50 -07:00
Jessica Lord
8d9aaf1d5e Fix date 2016-08-16 11:34:20 -07:00
Samuel Attard
ce986590cf
Clarify defaults 2016-08-16 15:39:36 +10:00
Samuel Attard
db27da5db0
Document the optional params 2016-08-16 15:38:35 +10:00
Jessica Lord
fd9a032839 Add About Electron documentation 2016-08-15 16:26:30 -07: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
bridiver
94c60379d1 don't convert a string to an array buffer 2016-08-13 13:35:23 -07:00
Haojian Wu
6a9801b82c Remove an extra space in front of #. 2016-08-12 22:01:30 +02:00
Samuel Attard
0b624315b2
Fix attribute typo in docs 2016-08-12 01:49:56 +10:00
Samuel Attard
5b07e8dd5b
Send isMainFrame as argument to did-navigate-in-page event 2016-08-12 01:27:50 +10:00
Kevin Sawicki
252aca8834 Add gperf and bison to package install commands 2016-08-10 17:34:58 -07:00
Cheng Zhao
6cd99ebf6b Merge pull request #6752 from lgalabru/feature/macos-native-notifications
Send events as native macOS notifications
2016-08-09 21:34:52 +09: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
Kevin Sawicki
11b14f7621 Add zoom items to menu template 2016-08-08 11:09:30 -07:00
Kevin Sawicki
bcc372568f Add zoom menu item roles 2016-08-08 11:09:30 -07:00
Kevin Sawicki
59ffe35781 Merge pull request #6765 from miniak/menu-speaking-roles
Add macOS specific speaking roles for MenuItem
2016-08-08 11:06:45 -07:00
Milan Burda
a6125c538e Add BrowserWindow.prototype.setThumbnailToolTip 2016-08-08 12:05:47 +02:00
Milan Burda
e84c82b4a7 Document boolean return value of app.setAsDefaultProtocolClient + app.removeAsDefaultProtocolClient 2016-08-08 02:26:27 +02:00
Milan Burda
a0cf013112 Report app.setUserTasks success/failure 2016-08-08 02:22:51 +02:00
Milan Burda
edc1a9614c Add macOS specific speaking roles for MenuItem 2016-08-08 00:02:32 +02:00
Ludovic Galabru
38cc56efee 🍎 Send events as native macOS notifications 2016-08-06 14:54:07 +02:00
Cheng Zhao
7173d8b01b Use getBitmap in docs 2016-08-05 18:08:36 +09:00
Cheng Zhao
1be253e1aa Cleanup the code of getBitmap 2016-08-05 18:05:44 +09:00
Heilig Benedek
b5c19a9c6d update docs 2016-08-05 17:40:42 +09:00
Cheng Zhao
736fbd46c6 docs: Show how to use bitmap data directly 2016-08-05 17:40:42 +09:00
Cheng Zhao
8c4ebdc88e Emit NativeImage objects in paint event 2016-08-05 17:40:42 +09: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
Cheng Zhao
64334fd40b Pass SkBitmap directly 2016-08-04 13:22:19 +09:00
Cheng Zhao
32d9382417 Merge pull request #6713 from MaxWhere/offscreen-rendering-fixes
Fixes buffer size in offscreen mode
2016-08-04 13:00:54 +09:00
Kevin Sawicki
05ab7d39ad Mark isDestroyed as public on BrowserWindow/WebContents 2016-08-03 14:58:22 -07:00
gellert
ca16132268 renames to bytesPerPixel and use nullptr 2016-08-03 19:39:23 +02:00
Milan Burda
d8f79bf29b docs: fix cwd description for shell.writeShortcutLink 2016-08-03 18:27:15 +02:00
gellert
50485a28d3 fixes buffer size and adds pixel size to paint event 2016-08-03 13:28:19 +02:00
Cheng Zhao
5dabc47440 Remove the view-painted event 2016-08-03 16:20:55 +09:00
Cheng Zhao
322fb97d8d Merge pull request #6686 from darkdh/swipe_prefs
Swipe back/forward should respect system preferences
2016-08-03 16:10:29 +09:00
Cheng Zhao
b9bcba7abe docs: Do not repeat processes for multiple times in menu.md 2016-08-03 16:08:54 +09:00
Cheng Zhao
163a6bd5c5 Merge pull request #6700 from calidion/patch-1
Update menu.md
2016-08-03 16:00:52 +09:00
Cheng Zhao
2e8ccfd8df Add Offscreen Rendering to guides 2016-08-03 15:38:24 +09:00
Anthony Tseng
e0c0e3e5f7 Add IsSwipeTrackingFromScrollEventsEnabled in system prefs 2016-08-03 10:27:56 +08:00
Eric
5ae112677b Update menu.md
1. add difference notice
2.  changed `render process` to `main process`
2016-08-03 10:10:56 +08:00
Cheng Zhao
63c34f3dcf docs: Use app.disableHardwareAcceleration() instead of --disable-gpu
The --disable-gpu switch does not work when passed with `appendSwitch`.
2016-08-03 10:32:29 +09:00
Cheng Zhao
ba9aa13bd8 Fix lint warnings in documentations 2016-08-03 10:15:38 +09:00
Cheng Zhao
363fabdcb4 Merge branch 'offscreen-rendering' of https://github.com/MaxWhere/electron into merge-offscreen 2016-08-03 10:09:48 +09:00
Milan Burda
87c9926fe8 Move Toggle Fullscreen to the bottom of the View menu 2016-08-02 18:08:41 +02:00
gellert
8eed91d87a Merge remote-tracking branch 'upstream/master' into speedup-gpu 2016-08-02 14:59:03 +02:00
Cheng Zhao
84bb82866d docs: the callbacks 2016-08-02 14:44:06 +09:00
Cheng Zhao
56b1abd64a Merge pull request #6685 from electron/document-contents-zoom
Implement and Document the zoom methods that are mapped to the webContents object
2016-08-02 14:41:09 +09:00
Cheng Zhao
7ac28b53e6 Merge pull request #6683 from gabriel/master
Add isVisible() to app.dock
2016-08-02 12:33:36 +09:00
Samuel Attard
b59f37de98 Document the async versions of getZoomFactor and getZoomLevel 2016-08-02 13:04:21 +10:00
Samuel Attard
a1f5ca1ad2 Document the zoom methods that are mapped to the webContents object 2016-08-02 12:28:13 +10:00
Felix Rieseberg
c36bcf47d3 📝 Fix link to macOS Debugging Instructions 2016-08-01 19:15:03 -07:00
Gabriel Handford
7bde92deb9 Add isVisible() to app.dock 2016-08-01 15:22:37 -07:00
Milan Burda
e7322edb3a docs: Improve ICO size list 2016-08-01 13:13:40 +02:00
gellert
439ad94afe Merge remote-tracking branch 'upstream/master' into speedup-gpu 2016-08-01 12:00:34 +02:00
Heilig Benedek
0eacee0058 add documentation for changes 2016-08-01 02:18:19 +02:00
Heilig Benedek
2b05be64b4 add documentation for changes 2016-08-01 02:14:45 +02:00
gellert
35ee99265e adds tests for osr 2016-07-31 17:10:53 +02:00
gellert
092fc92cb8 adds tutorial 2016-07-31 00:47:08 +02:00
gellert
f60d791fa8 adds docs for osr 2016-07-31 00:22:34 +02:00
Cheng Zhao
a769996b8d Merge pull request #6641 from electron/felix-macos-debugging
Add debugging instructions for macOS
2016-07-30 11:55:05 +09:00
Felix Rieseberg
ab69ae07b7 📝 Add debugging instructions for macOS
I already wrote up debugging instructions for Windows, but never got
around to writing them for macOS - until now! This adds a very basic
introduction to LLDB from the command line, which should empower people
to figure out what’s happening inside Electron when they call an
Electron method from JavaScript.
2016-07-29 10:19:58 -07:00
Milan Burda
e428d5db4f docs: fix argument types 2016-07-29 11:56:32 +02:00
Cheng Zhao
8bf30ace4b Merge pull request #6636 from yuya-oc/docs-win32-icon
docs: Add recommended sizes for Windows ICO icons
2016-07-29 10:11:05 +09:00
Cheng Zhao
6d3120b05c Merge pull request #6626 from Starefossen/patch-1
docs: mention app ready event for DevTools Extension tutorial
2016-07-29 10:02:01 +09:00
Yuya Ochiai
29d66eb0d0 📝 Add recommended sizes for Windows ICO icons
For #6396
Please refer to https://msdn.microsoft.com/en-us/library/windows/desktop/dn742485(v=vs.85).aspx
[ci skip]
2016-07-28 23:22:41 +09:00
Cheng Zhao
e73bd00854 Merge pull request #6629 from electron/download-item-get-save-path
Set download item save path to selected path from dialog
2016-07-28 15:23:43 +09:00
Kevin Sawicki
4e9b19074f Make downloadItem.getSavePath() public 2016-07-27 17:33:36 -07:00
Cheng Zhao
bf20bbc247 Merge pull request #6623 from electron/shortcut
Add shell.writeShortcutLink/readShortcutLink APIs
2016-07-28 08:48:52 +09:00
DaveJ
42640b6170 docs: Add click handler to tray window example 2016-07-27 23:56:00 +01:00
DaveJ
322fe36dea docs: Fix undefined variables 2016-07-27 23:23:26 +01:00
Dave Jeffery
4823b5582f docs: Explain how to use highlightMode with BrowserWindow
As discussed on https://github.com/electron/electron/pull/6620
2016-07-27 21:35:13 +01:00
Hans Kristian Flaatten
ba2b8c8d3e docs: mention app ready event for DevTools Extension tutorial 2016-07-27 22:01:01 +02:00
Cheng Zhao
eadffc6db8 docs: icon and iconIndex have to be set together 2016-07-27 19:49:17 +09:00
Cheng Zhao
d6234e11df docs: shell.writeShortcutLink/readShortcutLink 2016-07-27 16:47:24 +09:00
Cheng Zhao
b8bafbc5a3 Merge pull request #6620 from electron/tray-highlight-toggle
Add option to always highlight the tray icon
2016-07-27 10:49:38 +09:00
Cheng Zhao
99b523176b Merge pull request #6619 from electron/web-contents-copy-image-at
Add webContents.copyImageAt(x, y)
2016-07-27 10:15:38 +09:00
Kevin Sawicki
0ff6b87f8c Update tray.setHighlightMode docs 2016-07-26 13:59:19 -07:00
Kevin Sawicki
31564f079f Document webContents.copyImageAt(x,y) 2016-07-26 12:08:05 -07:00
Zeke Sikelianos
c3f26df577 standardize electron-capturer doc snippets 2016-07-26 09:49:02 -07:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
Cheng Zhao
89de791e9d docs: Mention the --msvs 2016-07-26 17:42:12 +09:00
Cheng Zhao
b34deb1d2f docs: x64 is the default build 2016-07-26 17:40:58 +09:00
Vadim Macagon
6cc68638e7 Normalize string quotes in desktopCapturer docs
Missed one string in my previous PR :(
2016-07-26 11:57:39 +07:00
Cheng Zhao
2b0cd97bb8 Merge pull request #6593 from enlight/improved-desktop-capturer-docs
Improve readability, and add a link to the navigator.getUserMedia API
2016-07-26 13:35:54 +09:00
Vadim Macagon
89309244b5 Improve the desktopCapturer docs
Made minor improvements to readability, and added a link to the
`navigator.getUserMedia` docs on MDN for convenience.
2016-07-26 10:48:38 +07:00
Luke Page
c365aa85c2 Clarify the default arguments for popup
The null / -1 defaults weren't very helpful, so changed to follow other documentation and write the behaviour if that param is missing.
2016-07-25 13:57:38 +02:00
Cheng Zhao
729b84f2ca Merge pull request #6576 from electron/browser-window-proxy-docs
Fix BrowserWindowProxy documentation
2016-07-25 16:55:49 +09:00
Cheng Zhao
66086880e2 Merge pull request #6575 from electron/asar-doc-fixes
fix wording in asar doc
2016-07-25 16:55:20 +09:00
Cheng Zhao
a30997867f Merge pull request #6573 from electron/native-image-doc
Fix documentation for NativeImage
2016-07-25 16:55:09 +09:00
Cheng Zhao
fd8cc63ca9 Merge pull request #6558 from deepak1556/session_proxy_patch
session: add proxyBypassRules option to setProxy api
2016-07-25 16:03:50 +09:00
Cheng Zhao
c497765dea Merge pull request #6524 from liusy182/painted-event-6426
add "view-painted" event to WebContent.
2016-07-25 16:02:50 +09:00
Zeke Sikelianos
a2ffab40f9 use an instance-variable-style name for BrowserWindowProxy 2016-07-22 15:00:10 -07:00
Zeke Sikelianos
3a9c57231e fix wording in asar doc 2016-07-22 14:52:43 -07:00
Zeke Sikelianos
9432cb9170 use standard-style javascript in nativeImage doc 2016-07-22 13:47:05 -07:00
Zeke Sikelianos
9ca0fbaeb7 fix capitalization and headings for NativeImage class 2016-07-22 13:42:27 -07:00
Cheng Zhao
99ec841a8e Merge pull request #6342 from electron/chrome52
Upgrade to Chrome 52
2016-07-22 08:53:33 -06:00
liusy182
6e83f454d7 documentation error pointed out in issue #6541 2016-07-21 22:46:46 +08:00
Cheng Zhao
b57665330c Merge branch 'master' into chrome52 2016-07-21 05:34:36 -06:00
deepak1556
aa6d79a3d8 session: add proxyBypassRules option to setProxy api 2016-07-21 10:14:54 +05:30
Cheng Zhao
a0c5749ac1 Merge pull request #6547 from electron/update-web-view-docs
docs: Update nodeintegration of web-view-tag.md
2016-07-20 05:18:47 -06:00
Cheng Zhao
99524bf490 Merge pull request #6540 from mattslay/patch-1
Update file-object.md
2016-07-20 05:13:43 -06:00
Cheng Zhao
e9e67179c3 docs: Update nodeintegration of web-view-tag.md
webview is now disabled when nodeIntegration is off.
2016-07-20 05:13:05 -06:00
Matt Slay
0e24d148fd Update file-object.md
Added a for loop to iterate over the array of files, which allows processing of multiple files being dropped over the "holder" div.
2016-07-19 23:51:58 -05:00
Anthony Tseng
42eb0c3eae serial number in hex string 2016-07-18 23:42:42 +08:00
liusi
d335d7d706 add "view-painted" event to WebContent. 2016-07-18 14:54:52 +08:00
Moriarty!~~
d10323b057 error link
> `[security introduction](../tutorial/security.md)`.
it should be `[security introduction](tutorial/security.md)`
2016-07-17 09:22:53 +08:00
Cheng Zhao
08491e1ceb Merge pull request #6511 from electron/more-docs-cleanup
Clean up API Docs
2016-07-16 09:57:04 +09:00
Kevin Sawicki
e24885b160 Mention how to reset thumbnail to entire window 2016-07-15 10:38:11 -07:00
liusi
154daa8d6a make Session::ClearStorageData's callback optional 2016-07-15 14:13:56 +08:00
Cheng Zhao
9eacd07eda Merge pull request #6489 from electron/webcontents-static-api
Document static methods on webContents
2016-07-15 11:02:00 +09: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
Cheng Zhao
d186a01815 Merge pull request #6497 from electron/windows-thumbnail
Add setThumbnailClip API on Windows
2016-07-15 10:18:39 +09:00
Cheng Zhao
5db758297f Merge pull request #6486 from MarshallOfSound/master
Add a getFeedURL API for the autoUpdater
2016-07-15 10:02:05 +09:00
Kevin Sawicki
297365b4f0 Add require example for webContents 2016-07-14 17:54:18 -07:00
Kevin Sawicki
4de4774325 Update headings/sections to follow docs styleguide 2016-07-14 17:46:58 -07:00
Cheng Zhao
7c56169633 Merge pull request #6495 from electron/link-to-boilerplates
link to boilerplates
2016-07-15 09:44:29 +09:00
Cheng Zhao
c3ed4b5527 Merge pull request #6493 from electron/elecron-devtools-installer
mention electron-devtools-installer as an alternative
2016-07-15 09:44:01 +09:00
Kevin Sawicki
1aa645522a Remove implicit references to Vista 2016-07-14 17:33:48 -07:00
Cheng Zhao
16e43a7f15 Merge pull request #6490 from wilsonpage/add-drop-text-support
Add support for dropped text in osx
2016-07-15 09:12:35 +09:00
Cheng Zhao
3ace677b41 Merge pull request #6474 from darkdh/cert_detail
Add more detail attributes for certificate-error
2016-07-15 08:45:36 +09:00
Zeke Sikelianos
7700c5e249 denote return type on process memory info methods methods 2016-07-14 16:10:19 -07:00
Zeke Sikelianos
595b827a13 Use common style to denote OS-specific arguments 2016-07-14 16:09:29 -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
ee677ea212 link to boilerplates 2016-07-14 14:57:06 -07:00
Zeke Sikelianos
52a2ed9205 fix typo 2016-07-14 14:16:02 -07:00
Zeke Sikelianos
f857be431a mention electron-devtools-installer as an automated alternative 2016-07-14 14:12:06 -07:00
Wilson Page
90f8a7e828 Add support for dropped text in osx 2016-07-14 18:25:58 +01:00
Kevin Sawicki
c680c0b85e Document static webContents methods 2016-07-14 09:00:29 -07:00
Samuel Attard
b367c65bcd Add docs for getFeedURL 2016-07-15 00:07:17 +12:00
Cheng Zhao
21a2feaf23 Merge pull request #6480 from electron/webcontents-focus
Execute role-based menu items on focused web contents
2016-07-14 12:47:07 +09:00
Cheng Zhao
183b599b9c Merge pull request #6470 from electron/session-options
Ad options for creating Session
2016-07-14 12:07:39 +09:00
Kevin Sawicki
e1459b7db7 Doc webContents.isFocused 2016-07-13 14:20:33 -07:00
Anthony Tseng
db39867ad9 Add more detail attributes for certificate-error 2016-07-13 22:14:47 +08:00
Zeke Sikelianos
9b1d1dc2c7 clarify rules for documenting classes 2016-07-12 22:00:28 -07:00
Zeke Sikelianos
4905d30dd6 fix heading levels on BrowserWindowProxy 2016-07-12 21:57:07 -07:00
Zeke Sikelianos
5ab4fd261c 🎨 2016-07-12 21:50:43 -07:00
Zeke Sikelianos
b20606c718 fix heading levels in Menu doc 2016-07-12 21:47:28 -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
Cheng Zhao
e7666b0448 docs: options of session.fromPartition 2016-07-13 12:23:14 +09:00
Plusb Preco
9ea4039887 📝 Fix grammatical typo
[ci skip]
2016-07-13 03:02:14 +09:00
Plusb Preco
039aebb74a 📝 Fix isolated link
[ci skip]
2016-07-13 02:59:29 +09:00
Plusb Preco
19765e70cf 📝 Fix typo
[ci skip]
2016-07-13 02:57:11 +09:00
Kevin Sawicki
66d16b2871 Add Windows label to login items settings API 2016-07-12 09:10:48 -07:00
Cheng Zhao
3eaa32fc87 Merge pull request #6447 from ellerbrock/broken-link-fix
fix broken link
2016-07-12 11:01:52 +09:00
Cheng Zhao
df0d2b89cd Merge pull request #6446 from electron/accessibility-api
Add API for Chrome's accessibility support state
2016-07-12 10:59:12 +09:00
Maik Ellerbrock
01cb024f44 fix broken link
fixed broken link "how to share data between web pages" in section "Differences Between Main Process and Renderer Process"
2016-07-12 07:31:18 +08:00
Kevin Sawicki
46a1e0382d Document accessibility support API 2016-07-11 14:41:35 -07:00
Robert D
2d40ced3be Fix link to locales.md 2016-07-11 11:37:22 -07:00
Vladimir Krivosheev
d824e3a959 docs: electron-userland package tools links
`electron-packager` and `electron-builder` now in the `electron-userland` github org — links fixed.
2016-07-11 13:05:02 +02:00
Cheng Zhao
26fe38a296 docs: showHiddenFiles 2016-07-11 13:52:44 +09:00
Cheng Zhao
e8e2763131 win: Add toolbar type for BrowserWindow 2016-07-11 12:46:50 +09:00
vsemozhetbyt
4f62050b01 Fix typo in the web-contents.md
📝 `false` -> `true` in the `webContents.print` `silent` explanation.

[ci skip]
2016-07-09 20:31:02 +03:00
mihaipocorschi
a3388b1d25 Fixed broken FAQ link in docs/README.md 2016-07-09 16:14:42 +03:00
Cheng Zhao
b70090170d docs: thickFrame option 2016-07-09 21:52:45 +09:00
Kevin Sawicki
d02a453c51 Merge pull request #6391 from electron/getlocale-oneline
New title and one-liner for app.getLocale() doc
2016-07-08 12:45:41 -07:00
vsemozhetbyt
1726327bfa Fix typo in the web-view-tag.md
📝 Remove a redundant # from a href hash.

web-contents.md##webcontentssendinputeventevent ->
web-contents.md#webcontentssendinputeventevent

[ci skip]
2016-07-08 22:15:51 +03:00
Jessica Lord
e25001e277 Rename file 2016-07-08 09:43:48 -07:00
Cheng Zhao
5713e0599b Merge pull request #6375 from electron/login-item
Add login item API
2016-07-08 10:39:20 +09:00
vsemozhetbyt
ba9baec27f Fix typos in the remote.md
📝 Fixes #6387

[ci skip]
2016-07-08 04:00:22 +03:00
Cheng Zhao
b02a83c96e Merge pull request #6390 from vsemozhetbyt/patch-1
One alphabetical reordering in the docs/README.md
2016-07-08 09:52:32 +09:00
Jessica Lord
ea64db9e5c More concise wording 2016-07-07 17:45:35 -07:00
vsemozhetbyt
9c5d36f0c6 One alphabetical reordering in the docs/README.md
📝 webContents, Tray -> Tray, webContents

If I get it right, only API TOCs should be ordered alphabetically,
so I've left other ones (Guides, Tutorials, Development) untouched.
I'm not so sure about API TOC Intro (three links below the "Synopsis"),
tell me if they should be sorted alphabetically too.

[ci skip]
2016-07-08 03:33:22 +03:00
Jessica Lord
ae8b78aff8 New title and one-liner 2016-07-07 17:33:06 -07:00
Kevin Sawicki
cde594775d Remove API that is no longer available 2016-07-07 16:41:08 -07:00
Kevin Sawicki
10bb8df09a Update login item API docs 2016-07-07 16:33:26 -07:00
Jessica Lord
00fab4688b Move and rename FAQ 2016-07-07 10:13:19 -07:00
vsemozhetbyt
34ed2c4da4 Fix a hash of a link href in the remote.md
📝 web-contents.md#webcontentsexecutejavascriptcode-usergesture ->
web-contents.md#webcontentsexecutejavascriptcode-usergesture-callback
2016-07-07 18:52:49 +03:00
Gabriel Augendre
72e811fea4 Highlight the whole eval() override
I updated the link to hightlight not only the first line but the whole `window.eval()` override.
2016-07-07 12:22:12 +02:00
Cheng Zhao
c70635daff docs: Some dlls are not there anymore 2016-07-07 10:17:49 +09:00
Kevin Sawicki
49b32b8380 Mention open as hidden is manually configurable 2016-07-06 14:17:19 -07:00
Kevin Sawicki
667b6d6370 Doc login item APIs 2016-07-06 14:10:25 -07:00
Kevin Sawicki
c2ecc49be2 Defer to webContents docs 2016-07-06 09:21:29 -07:00
Kevin Sawicki
ce4ef1ccb8 Update capturePage documentation for new location 2016-07-06 09:21:28 -07:00
vsemozhetbyt
c2bf6c2460 Fix disordered definitions in webContents doc
📝 Swap `clearSelection` and `keepSelection` definitions
for `webContents.stopFindInPage(action)` that seems to be in wrong order.

[ci skip]
2016-07-06 18:58:50 +03:00
Jonathan Sampson
7baf7372af modern.ie is no longer in use
The URL exists for historical reasons, but is no longer the primary URL for developer resources.
2016-07-05 19:34:33 -07:00
Cheng Zhao
8d3e09747a directWrite option is removed 2016-07-05 09:20:57 +09:00
Cheng Zhao
ba1fe322e9 docs: Use <a> as example 2016-07-03 15:27:26 +09:00
Cheng Zhao
b7459d50f9 docs: Dragging files out of the window 2016-07-03 15:26:22 +09:00
Cheng Zhao
f072d9dd3a docs: webContents.startDrag(item) 2016-07-03 15:10:59 +09:00
Cheng Zhao
74ebbf9c78 docs: Add trailing period 2016-07-02 20:27:14 +09:00
Samuel Attard
7f914c65de Update docs to match style guide 2016-07-02 23:21:45 +12:00
Samuel Attard
bbaab9b355 Document possible getLocale returns values. Closes #5363 2016-07-02 21:17:37 +12:00
Kevin Sawicki
b47d0e3e58 Tweak launcher note text 2016-07-01 08:51:25 -07:00
Cheng Zhao
1da2a1c2ae app.setBadgeCount should return boolean 2016-07-01 22:20:05 +09:00
Cheng Zhao
f8ec377123 docs: app.setBadgeCount 2016-07-01 17:44:09 +09:00
Cheng Zhao
36a0a491c9 Merge pull request #6216 from electron/class-docs
Add details to docs/styleguide.md
2016-07-01 05:34:01 +00:00
Cheng Zhao
3965440952 conjunctions don't have to be capitalized 2016-07-01 14:33:22 +09:00
Cheng Zhao
1626c3bf0a Use * instead of - for lists
`*` is used in most lists in our docs, let's keep consistency.
2016-07-01 14:30:55 +09:00
Cheng Zhao
83e9521d13 Update atom-shell-vs-node-webkit.md 2016-07-01 14:27:56 +09:00
Jonas Schwabe
768ff7af5a Add additional method isUnityRunning, fix multiple typos in docs 2016-06-29 20:22:17 +02:00
Jonas Schwabe
e2d389fbd4 Rename the unityLauncher api to launcher and make it available on linux in general. + Document it only works on ubuntu 2016-06-29 20:22:17 +02:00
Jonas Schwabe
336a55cb23 📝 docs for unity launcher badge api 2016-06-29 20:22:17 +02:00
Kevin Sawicki
5b8c4f55e7 Update key to be httpOnly instead of session 2016-06-29 08:39:20 -07:00
Cheng Zhao
e1ad64013e Cleanup code of beginFrameSubscription 2016-06-26 11:46:40 +09:00
Cheng Zhao
3d2ad0080d Merge pull request #6164 from MaxWhere/master
beginFrameSubscription bugfix and improvement
2016-06-26 02:39:59 +00:00
Heilig Benedek
5118def724 damaged -> dirty rename, fixed misc issues, changed signature, updated docs and added tests 2016-06-25 18:23:40 +02:00
Kevin Sawicki
f90ef12814 read/writeBookmark is not implemented on Linux 2016-06-24 17:16:38 -07:00
Zeke Sikelianos
aee111bf2f minor wording changes and tweaks 2016-06-24 15:59:30 -07:00
Kevin Sawicki
9479536bb8 Tweak return value description 2016-06-24 15:35:30 -07:00
Kevin Sawicki
6588b85ac9 Mention empty strings 2016-06-24 15:31:15 -07:00
Kevin Sawicki
30a628b46f Remove unsupported type 2016-06-24 15:29:39 -07:00
Kevin Sawicki
a2ba778adc Document clipboard bookmark support 2016-06-24 15:20:49 -07:00
Kevin Sawicki
9fab641ecb Add missing rtf key 2016-06-24 15:17:31 -07:00
Kevin Sawicki
63e2ee8e10 Add link to Boolean 2016-06-24 12:45:22 -07:00
Kevin Sawicki
47504c5a53 Use more lists 2016-06-24 12:40:55 -07:00
Kevin Sawicki
5dd7bf67e7 Minor formatting and wording tweaks 2016-06-24 12:28:41 -07:00
Sudar Abisheck
0e1caa5961 Update quick-start.md
Corrected the anchor text
2016-06-24 11:29:55 +05:30
Cheng Zhao
38592aaef7 Add details to docs/styleguide.md 2016-06-24 10:45:37 +09:00
Cheng Zhao
eb55fba9f4 Merge pull request #6211 from electron/debugging-main-process-docs
Update debugging main process docs
2016-06-24 00:25:26 +00:00
Cheng Zhao
fa023842d3 Merge pull request #6111 from electron/docs-formatting
Docs formatting
2016-06-24 00:24:57 +00:00
Kevin Sawicki
adc8c54a81 Minor formatting updates 2016-06-23 14:23:34 -07:00
Kevin Sawicki
eb8c1b1a50 Make update number message a note 2016-06-23 14:20:52 -07:00
Kevin Sawicki
5e389021eb Use upstream node-pre-gyp 2016-06-23 14:19:23 -07:00
Zeke Sikelianos
3dcbbe9f20 remove parens from type 2016-06-23 14:13:03 -07:00
Zeke Sikelianos
cfebf7aa6b fix list indentation 2016-06-23 10:36:16 -07:00
Cheng Zhao
e70c622a70 Merge pull request #6190 from electron/default-label-and-accelerator
Add default label and accelerator for menu item roles
2016-06-23 05:34:10 +00:00
Cheng Zhao
6cfd078d19 Merge pull request #6174 from electron/session-docs-cleanup
docs: Separate Cookies and WebRequest classes in session.md
2016-06-23 04:05:18 +00:00
Kevin Sawicki
e9222583cb toPng/toJpeg -> toPNG/toJPEG 2016-06-22 15:47:42 -07:00
Kevin Sawicki
4dbdcad05e Remove label/accelerators with role defaults 2016-06-22 14:37:16 -07:00
Kevin Sawicki
c98f419bc8 Doc role defaults 2016-06-22 14:10:44 -07:00
Milan Burda
c243cf0c0f Add BrowserWindow.prototype.setContentProtection(enable) 2016-06-22 10:40:33 +02:00
Cheng Zhao
1a74177e2d docs: Separate Cookies and WebRequest classes in session.md 2016-06-22 16:34:58 +09:00
Cheng Zhao
6b1df5838c docs: ses.setUserAgent(userAgent[, acceptLanguages]) 2016-06-22 16:05:38 +09:00
Zeke Sikelianos
271c39ceb3 OS X → macOS 2016-06-21 23:02:01 -07: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
Zeke Sikelianos
2a079b2e0a wether → whether 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
0ff50650d2 document drop-files event type 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
574e8974b6 undo heading changes to special-case session 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
a82a2485d7 fix debugger event headings 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
49fd3ff41b document platform-specific arguments 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
74e0535659 use unformatted raw code examples in styleguide 2016-06-21 22:54:43 -07:00
Zeke Sikelianos
0d481aaeb8 📝 use h3 headings for events and methods, per the styleguide 2016-06-21 22:54:43 -07:00
Cheng Zhao
62d0dbea5a docs: Reformat the menu-item.md 2016-06-22 13:23:07 +09:00
Cheng Zhao
8d08e215b2 Add "event" parameter for "click" handler of MenuItem 2016-06-22 11:22:14 +09:00
Kevin Sawicki
35097b244e Doc togglefullscreen menu item role 2016-06-21 09:43:29 -07:00
Kevin Sawicki
395c372702 Document quit role 2016-06-21 09:08:13 -07:00
Heilig Benedek
712141f153 Updated docs for beginFrameSubscription 2016-06-21 13:35:30 +02:00
Cheng Zhao
9d63199c37 docs: Make tray.md follow docs style guide 2016-06-21 16:20:33 +09:00
Cheng Zhao
11f242a241 docs: Tray.getBounds() 2016-06-21 16:13:50 +09:00
Charlie Hess
74321dce74 Add systemPreferences.subscribeLocalNotification. (#6150) 2016-06-21 00:48:42 +00: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
Cheng Zhao
c44a6ad8b8 Merge pull request #6135 from blainesch/patch-1
Add copy/pasta example for system preferences.
2016-06-20 00:34:40 +00:00
Samuel Attard
ea38916c27 Fix typo in DevTools Extensions tutorial 2016-06-20 02:24:00 +10:00
Blaine Schmeisser
c75f3a8b5e Add copy/pasta example for system preferences.
Most of the other api docs have one example of where to find the module in a copy/paste format. This pull request adds one for the system preferences.
2016-06-19 08:53:34 -07:00
Leonard Lamprecht
511bf83fe7 Improved wording 2016-06-18 15:28:22 +02: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
Mark Judd
bf6133d61f 📝 Fix minor text issues. 2016-06-17 11:45:12 -04:00
Cheng Zhao
1a70fd8efe Merge pull request #6087 from electron/public-app-menu-getter
Make Menu.getApplicationMenu() public
2016-06-17 00:40:14 +00:00
Cheng Zhao
245f9cdd7d Merge pull request #6076 from electron/build-from-source
Update the using-native-node-modules.md
2016-06-17 00:21:57 +00:00
Kevin Sawicki
a3b933f1f8 Fence block as yml 2016-06-16 15:26:58 -07:00
Kevin Sawicki
094098b571 Correct typos in docs 2016-06-16 15:19:38 -07:00
Machisté N. Quintana
296d49dc56 Make Menu.getApplicationMenu() public
Closes https://github.com/electron/electron/issues/6085
2016-06-16 12:43:01 -07:00
Cheng Zhao
611791ea30 Update the using-native-node-modules.md 2016-06-16 17:10:57 +09:00
Cheng Zhao
58bce74255 Merge pull request #6071 from banyudu/patch-2
DocFixit: fix spell error
2016-06-16 05:19:26 +00:00
Yudu Ban
17a4b61d54 fix spell error 2016-06-16 09:32:58 +08:00
Yudu Ban
d014f7fc76 fix spell error 2016-06-16 09:31:10 +08:00
Kevin Sawicki
9267004b53 Merge pull request #6052 from electron/doc-entitlements
Document entitlements needed for dialog APIs
2016-06-15 11:14:00 -07:00
Cheng Zhao
be90e2e9ff Improve the docs on loading flash plugin 2016-06-15 09:41:47 +09:00
Kevin Sawicki
5c5fb0e39e Tweak documentation link 2016-06-14 15:24:05 -07:00
Kevin Sawicki
bfde8b02bb Drop the certain 2016-06-14 15:22:12 -07:00
Kevin Sawicki
54d1647a5c Mention dialog entitlements 2016-06-14 15:20:29 -07:00
Jimi (Dimitris) Charalampidis
8121f913ca Improving test exit
Test should always exit (app.stop()) either on success or failure.
2016-06-14 16:36:54 +03:00
Cheng Zhao
af722cc104 Merge pull request #6029 from electron/web-contents-created-app-api
Add web-contents-created event to app
2016-06-13 23:31:47 +00:00
Cheng Zhao
fcc7dc774a Merge pull request #6026 from electron/ready-to-show
Add "ready-to-show" event and docs on showing window gracefully
2016-06-13 23:24:14 +00:00
Kevin Sawicki
88a81ef946 Doc web-contents-created 2016-06-13 09:01:06 -07:00
Kushagra Sharma
61c0981ac7 remove extraneous 'not'
[ci skip]
2016-06-13 20:14:42 +05:30
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