Commit graph

34 commits

Author SHA1 Message Date
Steve Kinney
5a9f28e034 📝 Update API documentation to ES6 [ci skip] 2016-05-04 11:59:02 -06:00
Zeke Sikelianos
2c8261b429 update excerpts based on feedback 2016-04-22 10:32:28 -07:00
Zeke Sikelianos
0527b17e42 blockquote summaries 2016-04-22 10:32:28 -07:00
Zeke Sikelianos
ee190ca62a create a one-liner description for each API 2016-04-22 10:32:28 -07:00
Christopher Dieringer
12f5e5072d Specify enumerable property accessibility 2016-01-10 21:02:07 -08:00
Cheng Zhao
5cacf79bc5 docs: Document the new style of remote module 2015-11-13 22:34:00 +08:00
Cheng Zhao
fbb8e61958 Replace "Url" in API names with "URL" 2015-11-13 16:03:40 +08:00
Cheng Zhao
eac2e7cc61 docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00
Antoine Pairet
4efff08007 Fix comments from @jlord 2015-10-28 17:55:18 +01:00
Antoine Pairet
974b5005bc Update from @jlord 2015-10-28 14:28:30 +01:00
Antoine Pairet
0c5fe03999 Fix module types available in the renderer process
The doc previously stated `only GUI-unrelated` modules are available to the renderer process. I think it should be `only GUI-related`
2015-10-28 11:40:01 +01:00
Ionică Bizău
01ed2c4222 Fixed the mapNumbers require call
Since mapNumber.js is a file, we should prefix it with "./", otherwise an error is thrown.
2015-09-17 12:24:12 +03:00
Jessica Lord
aae2d82c28 Update links to web-contents.md 2015-09-10 12:19:37 -07:00
Jessica Lord
279fd0a461 Standardize **Note:** 2015-09-09 14:09:14 -07:00
Jessica Lord
0fa0aedd86 Text edits 2015-09-01 19:08:31 -07:00
Jessica Lord
2ead38b03f Text edits on remote 2015-09-01 15:30:08 -07:00
Jessica Lord
50736296a7 Standardize remote 2015-08-28 22:17:35 -07:00
Tim Ruffles
4bc9bf7654 improve advice on callbacks passed from renderer to main
Remote is a great feature, it's a shame to put people off unnecessarily. I think the original warnings given are too extreme

The potential bugs that stem from not cleaning up event handlers (or any reference) are present in any Javascript code. We don't avoid using event-handlers in the DOM because we might forget to clean them up!

I've added an example of the behaviour of return values from synchronously called callbacks from renderer, and have changed the advice from 'you shouldn't do this' to 'be careful when you do this'.
2015-08-27 17:10:02 +01:00
Plusb Preco
ad24c11f32 Merge remote-tracking branch 'atom/master' 2015-08-21 11:41:07 +09:00
Plusb Preco
351dc4ed6b Translate more files, fix outdated remote.md section
Translate content-tracing(50%), remote docs.
Fix `Remote buffer` section as outdated.
2015-08-21 11:33:02 +09:00
Petr Felzmann
7842a90c5e Fix absolute url to github 2015-08-17 15:03:04 +02:00
Kurtis Rainbolt-Greene
6902b876a8 Typo in function name for remote 2015-07-02 21:58:31 -05:00
Cheng Zhao
72ebb2c9fe Merge pull request #1885 from lucidogen/patch-1
Added note and link for poorly documented operation.
2015-06-08 22:33:08 +08:00
Lucidogen Media
e4ae579b16 Added note and link for poorly documented operation.
Accessing renderer process from main process is not documented and as "remote" does the opposite, it seems fair to add a pointer here.
2015-06-06 13:38:00 +02:00
Lucidogen Media
582a42f97c Added ending semicolon for consistency. 2015-06-06 13:31:22 +02:00
Lucidogen Media
9a0a10e766 Fixed example with correct capturePage api. 2015-06-06 13:20:47 +02:00
Cheng Zhao
33a926c5d3 Fix typo 2015-05-22 10:32:59 +08:00
Cheng Zhao
4c10925694 Add remote.getCurrentWebContents API 2015-05-11 14:05:20 +08:00
Federico Bond
ed023a560e Fix wording in docs/api/remote.md 2015-05-10 02:54:37 -03:00
Cheng Zhao
d2682233fd docs: Atom Shell => Electron 2015-04-16 11:31:12 +08:00
Joseph Dykstra
b6875ad49b Renamed browser-side to main process
renamed a few occurances of "web page" to "renderer"
renamed a few files that had "browser" in their name to "main-process"
note that there are still many occurances of web page.
2015-03-26 10:20:31 -05:00
Cheng Zhao
854c59df5c docs: Make getCurrentWindow more clear, fixes #1035 2015-01-21 13:47:28 -08:00
Greg Mefford
74c517d186 Doc: grammar/content fixes in the remote module
Mostly minor grammatical issues, but also some content that seems to be incorrect based on the surrounding descriptions and example code.
2014-05-09 23:51:25 -04:00
Cheng Zhao
5933947000 📝 Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00
Renamed from docs/api/renderer/remote.md (Browse further)