mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
23789 commits 1 branch 183 tags 5.3 GiB
Commit graph

70 commits

Author SHA1 Message Date
Samuel Attard
eb6616e4e9
build: update to standard 14 (#24479) 2020-07-09 10:18:49 -07:00
Charles Kerr
c83f836faf
refactor: prefer using app.whenReady() (#21972) 
* docs: add references to app.whenReady() in isReady

* refactor: prefer app.whenReady()

In the docs, specs, and lib, replace instances of `app.once('ready')`
(seen occasionally) and `app.on('ready')` (extremely common) with
`app.whenReady()`.

It's better to encourage users to use whenReady():
1. it handles the edge case of registering for 'ready' after it's fired
2. it avoids the minor wart of leaving an active listener alive for
an event that wll never fire again
 2020-02-03 22:43:22 +00:00
Samuel Attard
db3cf52add
docs: add support for readonly,deprecated and platform doc annotations (#19478) 2019-07-26 16:12:59 -07:00
Samuel Attard
a96b6e2c96 build: move to the new docs parser (#18103) 
* build: move to the new docs parser

* chore: remove the bad getTitle param doc

* build: update parser/ts gen deps + fix some docs issues highlighted by GH desktop

* chore: apply suggestions from code review

Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>

* chore: update docs for accidentally removed things

* chore: update docs/api/command-line.md

Co-Authored-By: MarshallOfSound <samuel.r.attard@gmail.com>
 2019-05-06 08:29:01 -07:00
Shelley Vohr
d87b3ead76 chore: remove promisification deprecation callbacks (#17907) 
* chore: remove promisification deprecation callbacks

* update docs

* fix smoke test

* fix executejs issue

* cleanup leftovers

* fix webContents.executeJavaScript tests

* cleanup WebContents.prototype.takeHeapSnapshot

* fix "sets arbitrary webContents as devtools" test

* fix executeJavaScriptInFrame related tests
 2019-04-30 07:08:32 -07:00
Milan Burda
d3efc52745 feat: add webPreferences.enableRemoteModule option (#13028) 2018-10-13 20:50:07 +03:00
Samuel Attard
558fff69e7
chore: update to standard 12 2018-09-14 14:57:01 +10:00
az-chris
83dc8cc13b docs: update remote.md (#13229) 
* Update remote.md

Addressing Issue #9421

* Minor copyediting
 2018-06-16 16:21:07 +10:00
hkhere
0f1fcc3f4b docs: fix a typo in remote.md (#13084) 2018-05-29 03:14:06 -05:00
nicknish
30581f78a2 📝 Fix typo in remote api docs [ci skip] 2018-01-28 04:37:13 +08:00
Tiago Danin
74769da9a7 [Docs] Fix URLs and Paths (#11584) 
* Fix URLs and Paths in docs/

* Avoiding link break to /docs/development/updgrading-chrome.md

* Fix URLs and Paths in docs/ #2

* Removed double spaces in docs
 2018-01-12 10:24:48 -05:00
Toinane
3d4ef66775
add some markdown links 2017-11-29 12:13:45 +01:00
Vanessa Yuen
435e027dc3 fix linting for fenced codeblocks only (see electron/electronjs.org#868) 2017-11-20 14:33:25 +08:00
Kevin Sawicki
55bf2239df Remove spaces around brackets 2017-03-30 11:58:09 -07:00
Bret Comnes
b67c81226c
fix linting 2017-03-14 10:48:44 -07:00
Bret Comnes
85c48a2336
make main process example shorter 2017-03-13 17:20:11 -07:00
Bret Comnes
2276357f72
update with a tree 2017-03-13 17:18:23 -07:00
Bret Comnes
f82590b9ab Wrap at 80 2017-03-13 15:48:42 -07:00
Bret Comnes
46af3cefec Clarify remote require of relative modules 
The docs for the `remote.require(module)` method were a little too terse for me to understand the behavior of relative module loading for `remote.require` and I had to run an experiment to understand the behavior (e.g. is the relative path relative to caller of `remote.require` or relative to some other path in the project related to the main process?).   I think this is correct but someone please double check my understanding.

Adding an example and additional explanation should help clarify this.  Feel free to edit the copy as needed.
 2017-03-13 15:42:26 -07:00
Zeke Sikelianos
e57cb713b2 link process annotations to glossary 2016-12-21 13:47:40 -08:00
Kevin Sawicki
6352afb07a Link to return class type 2016-12-19 09:40:07 -08:00
Samuel Attard
494afec01d remote require could resolve to strings/numbers not just objects 2016-11-11 09:22:55 -08:00
Zeke Sikelianos
ac68de6215 document process(es) for all APIs 2016-11-03 10:26:00 -07:00
Long Nhat Nguyen
c017a7a1c7 Update url (#7598) 
* Update EventEmitter URL

* Update EventEmitter URL

* Enable click

* Update EventEmitter URL

* Update EventEmitter URL

* Update URL

* Update URL

* Update EventEmitter URL

* Tweak sentence and add perios
 2016-10-13 14:09:14 -07:00
Samuel Attard
d2a701a465 Document the return values of all methods in the docs 2016-09-25 12:59:30 +13:00
Kevin Sawicki
e7c4d2523b Mention mutating remote arrays and buffers 2016-09-21 10:44:54 -07:00
Zeke Sikelianos
28d42ba35b document missing method parameters 2016-08-25 10:52:19 -07:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
vsemozhetbyt
ba9baec27f Fix typos in the remote.md 
📝 Fixes #6387

[ci skip]
 2016-07-08 04:00:22 +03: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
Kevin Sawicki
9438ba3aaf Access remote from electron require 2016-06-10 10:24:35 -07:00
Ben Gotow
2bade868bb Update remote.md to mention enumerable property limitation 
#5599
 2016-05-19 09:31:02 -07: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
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