Commit graph

250 commits

Author SHA1 Message Date
CharlieHess
45e2f35eff Provide guidance in the docs. 2017-02-06 08:34:35 -08:00
Chandan Rai
93b0a2caa1 corrected typo 2017-02-03 18:58:21 +05:30
Kevin Sawicki
afa3bd2143 Put optional label before dash 2016-12-29 14:11:26 -08:00
Zeke Sikelianos
e57cb713b2 link process annotations to glossary 2016-12-21 13:47:40 -08:00
Kevin Sawicki
f99dabbac6 Merge pull request #8078 from electron/dts-docs-update-again
Update Docs
2016-12-21 13:39:53 -08:00
deepak1556
06701786c4 update docs 2016-12-07 13:26:06 +05:30
Samuel Attard
c9615a201c Update app docs 2016-11-25 23:23:45 +11:00
Samuel Attard
921b474919 Fixup app and bw docs 2016-11-25 23:21:25 +11:00
Samuel Attard
06960704c4 Update docs for dts again 2016-11-25 23:17:31 +11:00
Kevin Sawicki
cf690ae513 Merge pull request #7986 from salomvary/fix-before-quit-docs
Clarify docs on a `before-quit` behavior edge case
2016-11-22 16:51:26 -08:00
Kevin Sawicki
0d317a2e49 Add backticks around Info.plist 2016-11-22 07:49:56 -08:00
Ben Gotow
964c88a189 Update open-url docs to mention NSPrincipalClass
We got bit by a nasty bug today - if you change your app's info.plist `NSPrincipalClass` to something other to `AtomApplication` (We set it to NylasApplication via a bad find-replace), everything works except open-url is never fired. Add a small reference to the docs so folks know to check this key.
2016-11-21 16:55:18 -08:00
George Hafiz
aac31159b8 Update formatting to prevent '[] ()' sequences (e.g. String[] (optional)), which breaks MD rendering on GitHub and hides the array indication 2016-11-18 00:34:48 +00:00
Márton Salomváry
98e18a62e2 Clarify docs on a before-quit behavior edge case
See #7875
2016-11-16 10:38:57 +01:00
Samuel Attard
1a9b4b4671 First few docs made optional 2016-11-11 09:22:55 -08:00
Zeke Sikelianos
e8bb79310c document the process(es) in which APIs are available 2016-11-01 16:35:31 -07:00
Kevin Sawicki
65e6da2673 Add newlines before lists 2016-10-25 12:38:08 +09:00
Kevin Sawicki
632739ec6e Merge pull request #7590 from electron/docs-cleanup
Cleanup docs and standardize structs
2016-10-24 15:13:39 +09:00
Kevin Sawicki
b2559d7d28 Merge pull request #7596 from electron/function-param-types
Function param types
2016-10-24 12:40:41 +09:00
Dave Jeffery
00d641aaf7 Docs: Fix relative link to MAS builds tutorials
The link was 404'ing
2016-10-17 11:26:28 +01:00
Samuel Attard
20323e7032
Specifiy function param types in docs 2016-10-13 17:30:57 +11:00
Samuel Attard
78343a62b8
Cleanup docs and standardize structs 2016-10-13 14:38:06 +11:00
Kevin Sawicki
fcfc13c1ea Merge pull request #7579 from electron/tweak-about-panel-key-names
Use lower-case about panel option keys
2016-10-12 11:32:01 -07:00
Kevin Sawicki
1e4ef195bb Use lower-case about panel option keys 2016-10-12 11:18:21 -07:00
Zeke Sikelianos
6b7e375963 Merge pull request #7379 from electron/seperate-structs
Move reused object structures to a standard structures folder
2016-10-11 22:28:39 -07:00
Kevin Sawicki
58ef0bea17 Doc app.setAboutPanelOptions 2016-10-10 13:40:57 -07:00
Zeke Sikelianos
f80e81bf9f standardize 2016-10-06 12:20:00 -07:00
Samuel Attard
b859afc118 Update docs to follow the 'link first instance' standard 2016-10-06 12:19:38 -07:00
Bryan Bess
9bc6000cb5 📝 Fix misspelling in docs/api/app.md [ci skip] 2016-10-05 19:17:49 -05:00
Kevin Sawicki
5e936a24ac Add newline before list 2016-10-05 09:24:33 -07:00
Cheng Zhao
e1d68fa3cd Merge pull request #7374 from electron/fixup-return-values
Update docs to contain more specific return values
2016-09-29 16:44:08 +08:00
Kiavash Page
d42e51e33a app.md - fix relaunch arg concat syntax 2016-09-28 10:23:03 -07:00
Cheng Zhao
53d4c36332 Merge pull request #7353 from electron/no-login-item-apis-on-mas
document lack of MAS support for login item APIs
2016-09-28 19:20:32 +08:00
Samuel Attard
e0e47ea9a1 Update docs to contain more specific return values 2016-09-28 18:28:44 +13:00
Zeke Sikelianos
bb955b6202 document lack of MAS support for login item APIs 2016-09-26 11:00:13 -07:00
Samuel Attard
d2a701a465 Document the return values of all methods in the docs 2016-09-25 12:59:30 +13:00
Milan Burda
8567f79e67 Add killed argument for webContents.on("crashed") and app.on("gpu-process-crashed") events 2016-09-17 17:02:36 -07:00
Kevin Sawicki
4c4d585b84 initialization -> initializing 2016-09-13 09:37:03 -07:00
Kevin Sawicki
f373f2ae15 Mark app.isReady() as public 2016-09-13 09:35:39 -07:00
Cheng Zhao
b6079ff90b Merge pull request #7053 from electron/launch-from-notification
Send notification info to app.ready, on macOS
2016-09-09 20:01:39 +09:00
Charlie Hess
80f046c8df Update docs. 2016-09-03 12:03:58 -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
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
Samuel Attard
adf9acc468
Default app exit code to 0 2016-08-30 13:30:56 +10:00
Zeke Sikelianos
28d42ba35b document missing method parameters 2016-08-25 10:52:19 -07: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
Samuel Attard
ca971e978e
Return boolean instead of empty string when error occurs. Update docs 2016-08-18 18:02:13 +10: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
bridiver
94c60379d1 don't convert a string to an array buffer 2016-08-13 13:35:23 -07: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
Gabriel Handford
7bde92deb9 Add isVisible() to app.dock 2016-08-01 15:22:37 -07:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
Anthony Tseng
42eb0c3eae serial number in hex string 2016-07-18 23:42:42 +08:00
Anthony Tseng
db39867ad9 Add more detail attributes for certificate-error 2016-07-13 22:14:47 +08:00
Kevin Sawicki
66d16b2871 Add Windows label to login items settings API 2016-07-12 09:10:48 -07: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
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
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
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
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
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
Leonard Lamprecht
67dd19ed0f Replace OS X and Mac OS with macOS 2016-06-18 15:26:26 +02:00
Kevin Sawicki
094098b571 Correct typos in docs 2016-06-16 15:19:38 -07:00
Kevin Sawicki
88a81ef946 Doc web-contents-created 2016-06-13 09:01:06 -07:00
Brian R. Bondy
352a9cd6f2 Allow obtaining system Pepper Flash path 2016-06-08 16:40:15 -04:00
Cheng Zhao
02cfe30df9 Add app.disableHardwareAcceleration() API 2016-06-06 20:19:55 +09:00
Cheng Zhao
d3fe80991c docs: app.relaunch 2016-06-02 22:06:27 +09:00
Daniel Pham
f4c3f0423a 🎁 Add 'app.releaseSingleInstance()' 2016-05-26 18:50:06 -04:00
Daniel Pham
eb0889de38 🍎 Add fallback URL to handoff. 2016-05-24 21:06:14 -04:00
deepak1556
f68d0f324f deprecate app.allowNTLMCredentialsForAllDomains 2016-05-23 11:44:21 +05:30
deepak1556
62cad610e0 bring back app.allowNTLMCredentialsForAllDomains 2016-05-23 01:52:09 +05:30
Plusb Preco
9cbcd228f3 📝 Adjust line length to 80
[ci skip]
2016-05-19 18:32:43 +09:00
Robert Stanfield
2d46f6f66f It isn't entirely clear to me that 'window-all-closed' is used for
this purpose. I originally looked for an event that would fire if
all windows were closed and the reason was NOT due to the application
quitting; however, this differs in that it is called regardless of
whether the app was quitting.
2016-05-13 21:34:42 -04:00
Cheng Zhao
ed70a11ff8 Merge pull request #5477 from danhp/download-bounce
Add API: app.dock.downloadFinished(filePath)
2016-05-11 09:41:08 +09:00
Daniel Pham
6dae07b76f Add API: app.dock.downloadFinished(filePath) 2016-05-10 15:02:56 -04:00
Plusb Preco
ebc7f5cba0 📝 Remove whitespace
[ci skip]
2016-05-11 03:34:06 +09:00
Plusb Preco
f1b184ef78 📝 Fix code style issue
* Change `var` to `let`.
* Change `function() {}` to `() => {}`.
* Use shorthand function syntax on object notation.
* Remove spaces between object notation brackets.
* Small fixes.
2016-05-11 02:15:09 +09:00
Plusb Preco
139a4f984a 📝 Add missing semicolons
[ci skip]
2016-05-11 01:57:55 +09:00
Plusb Preco
4d7296e1db 📝 Match destructuring style
[ci skip]
2016-05-11 01:26:38 +09:00
Plusb Preco
5787bb0226 📝 Fix code style issue
* Match equality operators for consistent that `==`, `!=` by `===`,
`!==`.
* Match string expression notation `"` by `'`.

[ci skip]
2016-05-10 18:42:21 +09:00
Ben Gotow
ac905e7080 Add docs, avoid side effects when not currently default 2016-05-08 10:50:17 -07:00
Cheng Zhao
969a30fc3b Merge branch 'update-code-samples' of https://github.com/stevekinney/electron into stevekinney-update-code-samples 2016-05-05 20:55:25 +09:00
Cheng Zhao
c9c4ba39ab docs: We support arbitrary NSDictionary now 2016-05-05 17:07:46 +09:00
Cheng Zhao
7268f434b2 Fix code styling problems 2016-05-05 12:26:23 +09:00
Steve Kinney
5a9f28e034 📝 Update API documentation to ES6 [ci skip] 2016-05-04 11:59:02 -06:00
Charlie Hess
12764a66ed Add an accessor for the current activity type and write the simplest possible test. 2016-05-03 15:51:31 -07:00
Charlie Hess
a5a2e20449 📝 on using only strings. 2016-05-03 10:34:59 -07:00
Charlie Hess
21ae288ee7 📝 about the plist changes. 2016-04-30 13:03:10 -07:00