Commit graph

2113 commits

Author SHA1 Message Date
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
Cheng Zhao
ce00f4a273 Merge pull request #6013 from miniak/setIgnoreFocus
Add BrowserWindow.prototype.setIgnoreFocus
2016-06-13 07:18:10 +00:00
Cheng Zhao
04479b40a7 Merge pull request #6012 from miniak/menu-item-roles
Document 'zoom' role + add missing menu items (Delete / Paste and Match Style / Zoom)
2016-06-13 06:21:53 +00:00
Cheng Zhao
33a69fe50b Merge pull request #6008 from develar/patch-1
Add info about electron-builder to build windows installer
2016-06-13 06:16:53 +00:00
Cheng Zhao
4f1f0add27 docs: Reword the requirement of setApplication Menu 2016-06-13 10:52:12 +09:00
Cheng Zhao
9b566d8a40 Merge pull request #5999 from greggman/update-menu-docs-1
Document Menu.setApplicationMenu from main process
2016-06-13 01:42:47 +00:00
Cheng Zhao
8fe5dd22b2 Merge pull request #6018 from electron/string-map
Cleanup code for autoUpdater
2016-06-13 01:02:53 +00:00
Cheng Zhao
853d7b1b79 Merge pull request #5965 from electron/installed-extension-api
Add BrowserWindow.getDevToolsExtensions API
2016-06-13 00:45:58 +00:00
Cheng Zhao
a3786f66c9 Do not add JS wrapper for setFeedURL
When possible we should avoid adding wrappers in JS, it usually makes
code more difficult to mantain
2016-06-13 09:38:47 +09:00
Milan Burda
7a1d1ee0ea Add BrowserWindow.prototype.setIgnoreFocus 2016-06-12 20:20:57 +02:00
Milan Burda
f5699ad3a6 Document 'zoom' role + add missing menu items (Delete / Paste and Match Style / Zoom) 2016-06-12 19:21:52 +02:00
Milan Burda
c89d8b19b6 Add optional requestHeaders argument to autoUpdater.setFeedURL + allow calling mulitple times 2016-06-12 12:46:16 +02:00
Vladimir Krivosheev
109596501c Add info about electron-builder to build windows installer 2016-06-12 10:48:50 +02:00
Greggman
19c9170d6c Document Menu.setApplicationMenu from main process
You can't call Menu.setApplicationMenu until the app is ready.


[ci skip]
2016-06-11 14:09:53 +09:00
Kevin Sawicki
9438ba3aaf Access remote from electron require 2016-06-10 10:24:35 -07: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
34e01833d3 Merge pull request #5966 from electron/felix-docs-windows-store
Update Guide for Windows Store Apps
2016-06-09 17:36:55 -07:00
Felix Rieseberg
8204412f9b 📝 Update Guide for Windows Store Apps
- Updated the guide to reflect that electron-windows-store no longer
   requires container conversion prerequisites
 - Added a link and a note about using background tasks to include
   UWP features
2016-06-09 16:59:42 -07:00
Cheng Zhao
cbcbcaeb41 docs: Make the example cover all cases 2016-06-09 20:57:29 +09:00
Cheng Zhao
dcad25c98c Add isPaused and canResume 2016-06-09 20:51:01 +09:00
Cheng Zhao
3f1dba3016 docs: Update DownloadItem for getState 2016-06-09 20:35:12 +09:00
Cheng Zhao
2ec5406ca6 Merge pull request #5904 from deepak1556/extension_partition_patch
browser: set up extension protocol handler for each browser context
2016-06-09 08:04:58 +00:00
deepak1556
4749e18fc0 fix spec and docs 2016-06-09 10:48:05 +05:30
deepak1556
ebff40b5a5 add docs 2016-06-09 10:39:18 +05:30
Vadim Macagon
537c62a9a8 Update Build System Overview doc
`atom.gyp` was renamed to `electron.gyp` not long ago but this document wasn't updated.
2016-06-09 10:58:58 +07:00
Brian R. Bondy
352a9cd6f2 Allow obtaining system Pepper Flash path 2016-06-08 16:40:15 -04:00
Kevin Sawicki
f4c1cd11a0 Merge pull request #5921 from electron/webview-show-definition-for-selection
Add showDefinitionForSelection to webContents/webview
2016-06-08 10:40:10 -07:00
Kevin Sawicki
c66299bf66 Document webview.showDefinitionForSelection 2016-06-08 10:15:36 -07:00