Commit graph

1221 commits

Author SHA1 Message Date
Zeke Sikelianos
2853356b10 use alt, not option 2016-04-01 15:48:12 -07:00
Zeke Sikelianos
b92e86301a use cross-platform accelerator in globalShorcut documentation 2016-04-01 14:54:25 -07:00
Zeke Sikelianos
ac419038c6 use example accelerators that align with best practices 2016-04-01 14:09:01 -07:00
Alexandru Rosianu
ff7bb1e6cb Add squirrel-updates-server link in the docs
Add link to Aluxian/squirrel-updates-server in the docs page for autoUpdater
2016-04-01 14:28:52 +03:00
Kevin Sawicki
1eddaecef8 Merge pull request #4964 from jwheare/app-command-docs
Improve app-command docs, list arguments and explain command string
2016-03-31 15:45:16 -07:00
Kevin Sawicki
389b2b5cdd Merge pull request #4963 from preco21/document-fixes-2
Docs: Improve docs styles
2016-03-31 15:44:31 -07:00
Kevin Sawicki
f87e417f7f Merge pull request #4962 from erkyrath/doc-issue-4884
Added information about the enabled, visible, and checked properties
2016-03-31 15:43:22 -07:00
Kevin Sawicki
9e2dd13f9a Merge pull request #4959 from atom/check-url-before-opening
Only open http/https links in new-window example
2016-03-31 15:41:33 -07:00
Felix Rieseberg
ae5a6e61c5 📝 Add "remote" note to dialog docs
Ref #4943
2016-03-31 09:54:01 -07:00
Cheng Zhao
e23faceba0 docs: Add notes on app.getLocale 2016-03-31 17:22:09 +09:00
James Wheare
d4a14bc215 Improve app-command docs, list arguments and explain command string 2016-03-31 08:56:49 +01:00
Plusb Preco
546ad643e4 📝 Add missing docs
[ci skip]
2016-03-31 14:30:14 +09:00
Plusb Preco
a648528f43 📝 Normailze note markers
* Normalize note markers syntax `__` to `**`

[ci skip]
2016-03-31 14:22:28 +09:00
Plusb Preco
346ef9df0c 📝 Update docs styles
* Adjust line length to `80`
* Normalize whitespaces

[ci skip]
2016-03-31 14:16:14 +09:00
Andrew Plotkin
cfd2cdb9c4 Added information about the enabled, visible, and checked properties --
when they can be set and what they mean.

Also tidied up the grammar and clarified wording.
2016-03-30 23:57:28 -04:00
Cheng Zhao
be5e787edf Merge pull request #4885 from ArekSredzki/patch-1
Added electron-release-server link to the docs
2016-03-31 11:07:14 +09:00
Cheng Zhao
c220753c60 Merge pull request #4896 from felixrieseberg/default-protocol-handler
Enable Electron to set/unset itself as default protocol handler (OS X, Windows)
2016-03-31 10:38:57 +09:00
Cheng Zhao
0e3737423b Merge pull request #4843 from jwheare/mac-swipe-events
OSX: Expose 3-finger swipe events in browser-window
2016-03-31 10:37:27 +09:00
Kevin Sawicki
dd23b09569 Only open http/https links 2016-03-30 16:55:10 -07:00
Plusb Preco
c4a2329665 📝 Update docs styles
* Adjust line length to `80`
* Change platform marker `*` to `_`
* Enhance a note section

[ci skip]
2016-03-30 10:57:42 +09:00
Felix Rieseberg
1231360b2f Add API: RemoveAsDefaultProtocolHandler 2016-03-28 15:31:01 -07:00
Alejandro Gonzalez Sole
ab685ac335 Update power-monitor.md
Updated docs in power-monitor to reflect windows only events
2016-03-27 23:03:34 -04:00
Kevin Sawicki
8feb0f0440 Put link on same line as name 2016-03-24 15:57:42 -07:00
Felix Rieseberg
d2567b0381 Add API: SetASDefaultProtocolHandler
This PR adds an API enabling Electron to set itself as the default
protocol handler for a custom porotocl on both oS X and Windows.

For details, please see `docs/app.md`.

Closes #4857
2016-03-23 22:12:17 -07:00
James Wheare
8482109dea Switch to a single OS X swipe event with a direction argument 2016-03-23 15:20:11 +00:00
Arek Sredzki
951bd745aa Added electron-release-server link to the docs
By request from a couple users, I've added a link to the electron-release-server, that makes using the auto-updater much easier.
2016-03-22 16:35:03 -07:00
Kevin Sawicki
baa566adae Merge pull request #4851 from k0kubun/app-doc-set-name
Document `app.setName()`
2016-03-22 09:35:49 -07:00
Takashi Kokubun
8cf4574198 Document app.setName()
[ci skip]
2016-03-22 11:01:23 +09:00
Milan Burda
f84c41f684 Fix Menu documentation 2016-03-20 19:05:18 +01:00
James Wheare
03319a5426 OSX: Capture 3-finger swipe events in NativeWindow 2016-03-18 15:21:19 +00:00
Cheng Zhao
cbd37ad3b9 docs: List breakpad server implementations 2016-03-17 22:29:32 +09:00
Cheng Zhao
912ec1437b Merge pull request #4812 from thanpolas/patch-1
More info for crash reporter form type and payload
2016-03-17 22:24:10 +09:00
Cheng Zhao
f8b9a66ead docs: Make it clear image.getNativeHandle is OS X only 2016-03-17 21:55:44 +09:00
Cheng Zhao
081ab17e13 Merge pull request #4791 from atom/nativeimage-as-nsimage
Convert NativeImage instances to OS-specific representations
2016-03-17 21:49:46 +09:00
Thanasis Polychronakis
492269a0fd More info for crash reporter form type and payload 2016-03-15 15:49:34 +02:00
Paul Betts
f59752bf4f Update the docs to match 2016-03-14 19:51:37 -07:00
Paul Betts
5dea4b9b1c Add documentation 2016-03-13 20:11:43 -07:00
Robo
8378cbb1e8 webcontents: provide position of match with found-in-page event 2016-03-14 06:49:45 +05:30
Cheng Zhao
03ec5ced05 Merge pull request #4751 from maxbeatty/window-blur
Add blur method to window
2016-03-11 19:15:51 +09:00
Max Beatty
704b8335aa Add blur method to window ref #4724 2016-03-10 21:45:51 -08:00
Arek Sredzki
c1267b2320 Added 'show' & 'hide' events to browser-window, fixed visibilitychange event in renderer 2016-03-10 13:51:31 -08:00
Plusb Preco
ebf509bbe4 📝 Adjust 80 chars per line
[ci skip]
2016-03-10 16:54:07 +09:00
Daniel Pham
0b8c2545b9 📝 Document 'app.focus()'
[ci skip]
2016-03-09 09:03:38 -05:00
Machisté N. Quintana
f47851f1e7 📝 🎨 Hard wrap 2016-03-07 16:19:00 -08:00
Machisté N. Quintana
eb064240f8 📝 Link to OS X Cocoa Event Handling guide on actions 2016-03-07 16:11:58 -08:00
Cheng Zhao
aa8dbbf6b6 Merge pull request #4695 from dongjoon-hyun/fix_link_name
Fix link name.
2016-03-07 10:31:49 +09:00
Cheng Zhao
0e2ac2d802 Merge pull request #4646 from phamdaniel/dark-mode
Add API to check OSX's Dark theme
2016-03-07 09:53:03 +09:00
Daniel Pham
68b453770b 🍎 Rename 'isDarkModeEnabled' to 'isDarkMode' 2016-03-06 10:55:47 -05:00
Dongjoon Hyun
f9f20957a4 Fix link name. 2016-03-05 23:28:39 -08:00
Cheng Zhao
b7a40f3097 docs: Add missing key codes 2016-03-06 15:12:04 +09:00
Cheng Zhao
f5d79677fa Merge branch 'will-fullscreen' of https://github.com/MaxWhere/electron 2016-03-05 21:30:41 +09:00
Daniel Pham
63294892f0 Rename dark-mode-changed to platform-theme-changed 2016-03-03 23:58:58 -05:00
Daniel Pham
c4049cb393 🍎 Add 'dark-mode-changed' event to app api 2016-03-01 15:43:38 -05:00
Daniel Pham
eaac67ac60 🍎 Add 'isDarkModeEnabled' to app api 2016-03-01 13:12:21 -05:00
Andrea Parodi
fd11b7e7db Removed duplicate isDevToolsFocused entry 2016-02-27 20:34:51 +01:00
Heilig Benedek
bb42c85df8 resolve update conflicts 2016-02-27 03:23:10 +01:00
Heilig Benedek
bb0ac688b2 Reverted SetFullscreenable disabling maximize button on Windows and removed that from the docs. 2016-02-27 03:07:53 +01:00
Cheng Zhao
ebfc127628 Merge pull request #4522 from deepak1556/async_execute_javascript_patch
webContents: provide responses for executeJavscript method
2016-02-26 21:17:47 +08:00
gellert
070772b4b9 Added special key identifiers for OSX and Windows 2016-02-26 20:22:46 +08:00
Robert Lyall
6f45678e9c Fix Menu template API example 2016-02-25 18:28:03 +00:00
Robo
a734326907 track async api requests 2016-02-25 11:45:59 +05:30
Robo
2b547bd44a webContents: provide responses for executeJavscript method 2016-02-25 11:45:59 +05:30
Robo
6fcc197db8 webview: api to get webcontents and associated host webcontents 2016-02-24 11:55:15 +05:30
Heilig Benedek
39bb670719 Revert will-enter-full-screen event, matching osx fullscreen: false behaviour on windows instead 2016-02-22 10:23:56 +01:00
Brad Metcalf
2a6fcf48e5 Changed session to app to reflect rest of document 2016-02-18 13:41:22 -06:00
Cheng Zhao
aa03a9d0ef Merge pull request #4534 from apoco/menu-documentation
Link to Menu documentation
2016-02-18 20:14:08 +08:00
Jacob Page
9c9759a683 Link to Menu documentation
Added link to documentation about `Menu` objects
2016-02-17 21:30:01 -08:00
Kevin Sawicki
42041cd402 Use markdown list for new options param 2016-02-17 08:56:59 -08:00
Ben Gotow
d8679b3899 Allow openExternal to open URLs in the background #3224 2016-02-17 08:56:58 -08:00
Cheng Zhao
0ba86b9716 docs: Make variable names follow previous example 2016-02-16 23:10:05 +08:00
Destan Sarpkaya
afacca252e add a new platform definition for linux
On Linux in order for changes made to individual `MenuItem`s to take effect, you have to call `setContextMenu` again

Regarding https://github.com/atom/electron/issues/1473
2016-02-16 16:24:05 +02:00
Cheng Zhao
e47a815c38 Merge pull request #4482 from lukeapage/patch-7
spelling fixes and americanisms
2016-02-16 20:22:31 +08:00
Cheng Zhao
25ac6f0f37 Merge pull request #4480 from apoco/single-instance-clarification
makeSingleInstance clarification
2016-02-16 20:17:18 +08:00
Cheng Zhao
55642d257d Merge pull request #4494 from pra85/patch-3
docs: fix a minor typo
2016-02-16 12:28:08 +08:00
Cheng Zhao
fded8d80b1 docs: Remove unnecessary "properties: " suffix 2016-02-16 12:11:05 +08:00
Cheng Zhao
2b406ccaf7 Optional => optional 2016-02-16 11:54:41 +08:00
Cheng Zhao
b8e8e4c930 docs: Cleanup the IPC docs 2016-02-16 11:34:39 +08:00
Cheng Zhao
d035fc2816 Merge pull request #4453 from lukeapage/patch-6
Docs - clarify ipc arguments
2016-02-16 11:08:35 +08:00
Prayag Verma
367a3524b9 docs: fix a minor typo
Remove extra `will`
2016-02-16 07:51:14 +05:30
Luke Page
a141d6b3d4 spelling fixes and americanisms 2016-02-15 06:51:20 +01:00
Luke Page
2c6e5d0464 Clarify arguments sent via ipc 2016-02-15 06:29:52 +01:00
Jacob Page
17603d5dfb makeSingleInstance clarification
Removed callback return value from the sample code for makeSingleInstance because it appears to not be used for anything.
2016-02-14 19:13:11 -08:00
Plusb Preco
e71eeda73c Remove unnecessary line feeds
[ci skip]
2016-02-12 22:38:08 +09:00
Kevin Sawicki
3af20729bd Merge pull request #4363 from Vj3k0/master
Adding support to write RTF to clipboard.
2016-02-09 13:23:47 -08:00
Heilig Benedek
157a290e38 📝 Adding documentation for will-enter-full-screen event 2016-02-09 02:41:19 +01:00
Adam Lynch
5911c45b54 Docs: app: small process.argv clarification 2016-02-07 17:31:37 +00:00
Kevin Sawicki
18631df88b Merge pull request #4378 from markisadesignerd/ipc-renderer-doc-typo
📝 Fixing typo in ipc-renderer
2016-02-05 10:10:26 -08:00
Vjekoslav Ratkajec
d0d336eee7 Merge remote-tracking branch 'upstream/master' 2016-02-05 09:11:24 +01:00
Vjekoslav Ratkajec
252b12be13 Add readRtf feature with appropriate spec test. Docs updated as well. 2016-02-05 09:06:21 +01:00
Vjekoslav Ratkajec
acd5d40ab0 Adding support to write RTF to clipboard. 2016-02-04 19:38:47 +01:00
chris-ls
48c6692311 Clarify overlay description
'16px' is ambiguous and not clear (4 x 4 px? or 16 x 16px)
2016-02-04 15:36:41 +13:00
Mark Potnick
b9e2806042 Fixing typo 2016-02-03 15:15:13 -05:00
Cheng Zhao
f624800881 Merge pull request #4314 from deepak1556/download_cancel_patch
fix crash when default download is canceled
2016-02-02 18:40:44 +08:00
Robo
2819af9586 fix lifetime of downloadItem class when defaultdownload canceled 2016-02-02 15:54:51 +05:30
Robo
ce2ea963b9 session: api to clear host resolver cache 2016-02-02 02:06:49 +05:30
Cheng Zhao
69f93a7528 Merge pull request #4223 from deepak1556/notification_disable_patch
session: add setPermissionRequestHandler api
2016-02-01 20:51:22 +08:00
Robo
b575cd0ef9 add fullscreen permission type 2016-02-01 16:22:05 +05:30
Cheng Zhao
e450d1586e Merge pull request #4288 from MaxWhere/master
Adding cursor-changed event to webContents
2016-02-01 17:03:16 +08:00
Robo
db26dcaf4c expose handler from session and remove permission-request event 2016-02-01 12:23:51 +05:30
Heilig Benedek
745253a369 Quick fix for the memory leak + docs 2016-02-01 07:17:58 +01:00
Cheng Zhao
7fdff522d6 Merge pull request #4292 from be5invis/patch-1
Add link to BrowserWindow::setMenu in docs/api/menu.md
2016-02-01 13:19:59 +08:00
Cheng Zhao
457c7f55e6 Merge pull request #4271 from thingsinjars/master
🍎 Add 'Hide' to App API for OS X only
2016-02-01 12:54:07 +08:00
Belleve Invis
1d629640bf Add link to BrowserWindow::setMenu 2016-02-01 00:28:44 +08:00
Heilig Benedek
066c189249 Renamed some cursor types to their CSS names and added a way to handle custom cursors properly. 2016-01-31 17:00:14 +01:00
Heilig Benedek
61e0219e91 Added documentation, restructured the files to fit better with electron's style and fixed a typo in keyboard_util's name. 2016-01-31 02:27:14 +01:00
Simon Madine
f9efdc4435 🍎 Add Show to API for OS X 2016-01-30 22:30:38 +01:00
Robo
f7556de9fb add spec for new permissions 2016-01-30 19:10:52 +05:30
Kevin Sawicki
d89bda5c68 Merge pull request #4274 from petrfelzmann/doc-bullets-formatting
fix bullets formatting in documentation
2016-01-29 13:08:13 -08:00
Brad Metcalf
bdc2b2559c Added missing angle bracket to replace() method 2016-01-29 13:27:47 -06:00
Petr Felzmann
0169f31feb fix bullets formatting in documentation 2016-01-29 20:10:18 +01:00
Simon Madine
7a370ccd0f 🍎 Add 'Hide' to App API for OS X only 2016-01-29 16:09:54 +01:00
Robo
f32bf08eb3 add spec 2016-01-29 15:23:28 +05:30
Robo
85e13333c3 webview: add permission-request event 2016-01-29 15:23:28 +05:30
Cheng Zhao
d195cc3796 docs: uploadData is optional 2016-01-28 18:59:58 +08:00
Cheng Zhao
f820b0db83 docs: Revise the webRequest and protocol docs 2016-01-28 18:59:07 +08:00
Robo
dc0151099c session: provide uploadData with webrequest api when available 2016-01-27 18:39:40 +05:30
Cheng Zhao
a83aee90e5 No need to use scoped_nsobject for id 2016-01-25 15:15:58 +08:00
Cheng Zhao
58127e3d52 Merge pull request #4217 from yamatoya/master
Add Japanes translated docs, improve a doc style.
2016-01-24 22:42:51 +08:00
Cheng Zhao
253a4f226f Merge pull request #4211 from ragingwind/dock-seticon
Add app.dock.setIcon to change icon of dock
2016-01-24 22:36:28 +08:00
Cheng Zhao
e1e58b642e Merge pull request #4182 from deepak1556/debugger_api_patch
browser: add webContents.debugger api
2016-01-24 21:43:18 +08:00
Cheng Zhao
7761815339 Merge branch 'bg-color-pr' of https://github.com/evgenyzinoviev/electron 2016-01-24 21:33:53 +08:00
Takahito Yamatoya
42493a7ed3 Add Japanes translated docs, improve a doc style. 2016-01-24 19:47:12 +09:00
Cheng Zhao
5372b6cd91 Fullscreenable => FullScreenable 2016-01-24 14:31:36 +08:00
ragingwind
7229d2462a Add app.dock.setIcon to change icon of dock 2016-01-24 08:30:14 +09:00
Cheng Zhao
31624995bc Merge pull request #4202 from evgenyzinoviev/shadow-pr
Added hasShadow option to BrowserWindow on OS X
2016-01-22 23:56:38 -08:00
Cheng Zhao
8cabe0f008 Merge pull request #4156 from evgenyzinoviev/windows-pr
Improvements in BrowserWindow
2016-01-22 23:42:41 -08:00
evgenyzinoviev
000af78d41 doc fix 2016-01-23 01:37:18 +01:00
evgenyzinoviev
e071e4f310 doc updated 2016-01-23 01:20:42 +01:00
evgenyzinoviev
ff41b4a267 added hasShadow option to BrowserWindow (osx) 2016-01-23 01:16:08 +01:00
evgenyzinoviev
3182504969 maximizable, fullscreenable docs 2016-01-22 23:32:09 +01:00
Cheng Zhao
d1051b55cc docs: Default value of positioningItem 2016-01-22 11:32:14 -07:00
Cheng Zhao
2d8e5e3a16 docs: Default parameter for Menu.popup 2016-01-22 11:29:26 -07:00
Cheng Zhao
ea9b0cfed0 Merge pull request #4192 from evgenyzinoviev/menu-pr
Menu.popup: specify positioning item (OS X)
2016-01-22 10:49:17 -07:00
Robo
3a60ab386c add spec 2016-01-22 19:10:48 +05:30
Robo
df5bad3f89 fix api and docs 2016-01-22 10:27:25 +05:30
evgenyzinoviev
072ab0ddea specify positioning item for popup menus 2016-01-22 03:18:27 +01:00
Cheng Zhao
b039741c6b Merge pull request #3902 from bengotow/asar-perf
Add env var to export a hint file to optimize ASAR ordering
2016-01-21 16:46:49 -07:00
Ben Gotow
ed34e33fbf Fix typos in environment-variables.md 2016-01-21 14:46:08 -08:00
Ben Gotow
b9d62d2cab Turn on logging via a command line env var 2016-01-21 14:46:08 -08:00
Jessica Lord
1b8200ea34 Merge pull request #4188 from Rosey/update-menu-doc
📝 Use correct shortcut for 'Hide Others' menu item example
2016-01-21 15:45:49 -07:00
Cheng Zhao
21f5e27a5e Merge pull request #4161 from gabriel/master
Support backgroundColor for window on mac
2016-01-21 15:42:21 -07:00
Rose Robertson
859d9763e9 📝 Use correct shortcut for 'Hide Others' menu item example
As per https://support.apple.com/en-gb/HT201236, the correct keyboard shortcut
for hiding all but the current window is Command-Option(Alt)-H.
2016-01-21 14:31:18 -08:00
Cheng Zhao
bbf622187c Merge pull request #4178 from deepak1556/webview_blinkfeatures_attributes_patch
webview: add blinkfeatures attribute
2016-01-21 15:03:33 -07:00
Cheng Zhao
56e8ddbdaf Merge pull request #4186 from CharlieHess/webview-load-url
Expose loadURL for the webview tag.
2016-01-21 14:53:32 -07:00
Cheng Zhao
000625e23f Merge pull request #4163 from deepak1556/web_preferences_fonts_patch
browser: add font related settings to webpreferences
2016-01-21 14:35:30 -07:00
Charlie Hess
7192a8517b Expose loadURL for the webview tag. 2016-01-21 13:31:35 -08:00
Gabriel Handford
239baa3e9a Support backgroundColor for window on mac 2016-01-21 11:07:33 -08:00
Robo
0e2323c9c8 browser: add webContents.debugger api 2016-01-21 23:52:23 +05:30
Robo
fab34b400e webview: add blinkfeatures attribute 2016-01-21 15:43:41 +05:30
Robo
8a00406862 browser: add font related settings to webpreferences 2016-01-21 13:30:05 +05:30