Samuel Attard
e73a0e6cc6
docs: replace the atom.io headers URL with electronjs.org ( #18328 )
2019-05-21 16:17:07 +09:00
Charles Kerr
d1207e9d8f
docs: use "Breaking Changes" as the changes doc's title ( #18326 )
...
* Use "Breaking Changes" as the changes doc's title.
Multiple people have commented that this important page is difficult
to find, in part because people search for "Breaking" or "Changes" or
"Breaking Changes" rather than "API Contract".
This PR changes the name to "Breaking Changes" so that it'll show up
on electronjs.org/docs/.
It also adds a backwards-friendly link so people still searching for
"API Contract" will get a redirect. I'm not sure if this is necessary --
the actual URL of https://electronjs.org/docs/api/breaking-changes is
unchanged -- would especially welcome feedback on this part.
* fixup! Use "Breaking Changes" as the changes doc's title.
* fixup! Use "Breaking Changes" as the changes doc's title.
2019-05-21 16:15:57 +09:00
Lucas Gabriel Schneider
286fdaa53c
fix: docs/api/browser-window.md: fix typo ( #18367 )
2019-05-21 15:42:27 +09:00
Andrey
204e3808d2
docs: add parentheses + change lower case to upper case in some places ( #18368 )
...
* fix: add parentheses
Add parentheses to the end `app.showAboutPanel`, because this is method.
* fix: change 'Promise<string>' to 'Promise<String>'
Change `Promise<string>` to `Promise<String>`, because this is class name.
* docs: change lower case to upper case
Change lower case in word `menu` to upper case - `Menu`, because it's method.
2019-05-21 15:41:41 +09:00
Milan Burda
dbb8617214
docs: update sandbox-option.md ( #18275 )
...
Co-Authored-By: Mark Lee <malept@users.noreply.github.com>
2019-05-20 17:34:57 +02:00
Milan Burda
7e2cbf528e
docs: link to better list of icons for nativeImage.createFromNamedImage() ( #18336 )
2019-05-18 22:00:08 +02:00
Milan Burda
2b4ad2cb09
feat: add 'gpu-info-update' event to app ( #18250 )
2019-05-18 10:06:48 +09:00
Milan Burda
76783e2a90
fix: 'page-title-updated' event forwarding + documentation ( #18270 )
2019-05-16 12:33:16 +03:00
Samuel Attard
2a08bfbcc6
docs: update type for responseHeaders in the webRequest module ( #18302 )
...
Fixes #18298
2019-05-15 18:20:37 -07:00
Milan Burda
6609138959
feat: add webContents 'zoom-changed' event ( #17747 )
2019-05-14 09:40:40 +03:00
Milan Burda
3a5e6f2551
feat: allow setting working directory in app.setUserTasks() / app.setJumpList() ( #18148 )
2019-05-13 19:17:12 +03:00
Milan Burda
019b31d084
chore: remove deprecated APIs ( #18159 )
2019-05-09 14:48:10 -04:00
Jeremy Apthorp
96e19f1cc4
docs: fix name of Backtrace in crash reporter docs ( #18180 )
2019-05-09 10:30:37 -07:00
Jeremy Apthorp
be484ee8a4
docs: note session.clearAuthCache planned change for 7.0 ( #18185 )
...
* docs: note session.clearAuthCache planned change for 7.0
* Update breaking-changes.md
2019-05-09 10:58:01 -04:00
Shelley Vohr
02710ef574
refactor: make templateImage a property on nativeImage ( #18124 )
...
* refactor: make templateImage a property on nativeImage
* Update docs/api/native-image.md
Co-Authored-By: codebytere <codebytere@github.com>
* fix nativeImage prototype deprecation
* update for new property name
* Update docs/api/native-image.md
Co-Authored-By: codebytere <codebytere@github.com>
2019-05-07 06:52:07 -07:00
Bobby Galli
175fae722a
docs: added BugSplat to list of hosted solutions ( #18162 )
2019-05-06 19:37:24 -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
9ec59cbc6c
docs: clarify clipboard type options ( #18107 )
2019-05-06 08:11:47 -07:00
Shelley Vohr
6d96f30ed3
refactor: make shell.OpenExternal async ( #17135 )
2019-05-03 13:53:45 -07:00
Michelle Tilley
4808f30538
fix: revert to previous documentation folder structure ( #18127 )
2019-05-02 15:17:17 -07:00
Samuel Attard
d4f5ebefe6
feat: allow setting of global fallback user agent ( #18016 )
...
* feat: allow setting of global fallback user agent
* spec: add tests for app.set/getUserAgentFallback
2019-05-01 16:34:42 -07:00
bughit
493af7f84c
document the loadURL promise pre-attached rejection handler ( #18043 )
2019-05-01 14:04:21 -07:00
Milan Burda
d2cebc62d1
docs: fix webContents 'new-window' event handler sample ( #18067 )
2019-05-01 10:49:42 -07:00
Shelley Vohr
8d83518f9a
refactor: make name a prop on app ( #17701 )
...
Update app.name to be a property on app.
2019-04-30 13:55:33 -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
Shelley Vohr
7b55ee9d36
refactor: allow requiring modules with no side effects ( #17496 )
2019-04-30 09:46:08 +09:00
pathim
cc1e8ecef6
docs: Correct doc for registerFileProtocol ( #18022 )
...
In the registerFileProtocol docs the "headers" argument of the callback was described as being a list. In fact is has to be an Object mapping header-entries to values. This can be seen in Line 326 of `/spec/api-protocol-spec.js` [fe618631f1/spec/api-protocol-spec.js (L326)
].
2019-04-29 15:26:55 -07:00
Samuel Attard
84212b8e8b
docs: add example on handling the webPrefs change ( #17971 )
...
* docs: add example on handling the webPrefs change
Fixes #17967
* Update breaking-changes.md
2019-04-26 13:30:45 -07:00
Shelley Vohr
e1acfffaf8
docs: remove outdated refs to protocol.registerStandardSchemes ( #17959 )
2019-04-25 15:56:59 -07:00
Shelley Vohr
075b818a8e
fixes ( #17363 )
2019-04-25 15:44:54 -07:00
Shelley Vohr
2108044bdb
docs: move organizational info docs to new directory ( #17865 )
...
* docs: move organizational info docs to new directory
* fix some markdown lint issues
2019-04-25 15:14:19 -07:00
nixxquality
4556433f3b
docs: fully document MenuItem instance properties ( #17479 )
...
* document menuItem instance properties
* correct some types
* add correct click documentation
2019-04-24 09:53:15 -07:00
Milan Burda
253d049ac9
chore: remove deprecated app.enableMixedSandbox() ( #17894 )
2019-04-23 21:07:40 -07:00
Shelley Vohr
0749dc4cc1
refactor: make app logs dir creation opt-in ( #17841 )
...
Previously, we were creating the app logs folder at a predefined location during initial electron startup, which meant that it had to be manually removed and prevented clean app portability. This refactors that implementation such that it's now an opt-in feature and developers must call app.setAppLogsPath(path) with an optional custom path in order to set this directory.
2019-04-18 22:04:58 -07:00
Kilian Valkhof
ea6641afe5
docs: explanation on using protocols with partitions ( #17759 )
...
* docs: explanation on using protocols with partitions
* linting fixes
* Update docs/api/protocol.md
Co-Authored-By: Kilian <kilian@kilianvalkhof.com>
* Update docs/api/protocol.md
Co-Authored-By: Kilian <kilian@kilianvalkhof.com>
* Update docs/api/protocol.md
Co-Authored-By: Kilian <kilian@kilianvalkhof.com>
* be more explicit about there being a default session.
2019-04-18 12:40:04 -07:00
Shelley Vohr
f1ee35e281
doc: document occasional mismatch between NSImageName and string ( #17826 )
2019-04-17 15:06:51 -07:00
Samuel Attard
f901170a4f
docs: fix doc linter warnings ( #17818 )
2019-04-16 19:03:17 -04:00
Shelley Vohr
b3d8db6996
docs: note desktop audio limitation on macOS ( #17738 )
...
Closes #10515 . Notes fundamental limitation in `navigator.mediaDevices.getUserMedia` for audio capture on some platforms so that users are aware of the ongoing issue and provides a potential workaround.
2019-04-16 10:49:31 -07:00
Shelley Vohr
9c3cb55ef2
refactor: make accessibilitySupportEnabled a property on app ( #17362 )
...
* refactor: make accessibilitySupport a prop on app
* fix docs
* update spec
2019-04-04 19:49:04 -07:00
Tyler Dennis
5b696491db
docs: remove webaudio doc from browserwindow options ( #17633 )
2019-04-02 13:46:45 -07:00
Shelley Vohr
0431997c8d
refactor: make applicationMenu a property on app ( #17361 )
2019-04-02 13:36:57 -07:00
Shelley Vohr
d412582f72
docs: clarify cookie domain normalization ( #17590 )
2019-04-02 13:04:20 -07:00
Shelley Vohr
8ea33d69ac
fix: match net module headers & http.IncomingMessage headers ( #17517 )
...
* fix: match net module headers & http.IncomingMessage headers
* update net doc for cleanliness
* address feedback from review
* Update spec/api-net-spec.js
Co-Authored-By: codebytere <codebytere@github.com>
* add special cookie case
2019-04-02 07:41:19 -07:00
Milan Burda
8cf15cc931
feat: only allow bundled preload scripts ( #17308 )
2019-03-28 11:38:51 +01:00
Shelley Vohr
4e57a732a8
feat: allow windows to be excluded from the windows menu ( #17404 )
...
* feat: allow windows to be excluded from the windows menu
* excludedfromWindowsMenu => excludedFromShownWindowsMenu
* implement no-op for win & linux
2019-03-27 08:10:23 -04:00
Milan Burda
546466b209
feat: add <webview>.getWebContentsId() ( #17407 )
2019-03-26 10:57:27 +09:00
Samuel Attard
784f9742bc
build: auto-fix whitespace in docs in pre-commit hook ( #17490 )
2019-03-21 12:15:55 -07:00
Milan Burda
07b02653ba
docs: update sandbox-option.md ( #17468 )
...
* docs: update sandbox-option.md
* Update docs/api/sandbox-option.md
Co-Authored-By: miniak <milan.burda@gmail.com>
2019-03-21 14:41:53 +01:00
Shelley Vohr
b25279df89
docs: clarify documentation for getLastCrashReport ( #17458 )
...
* docs: clarify documentation for getLastCrashReport
* address feedback
2019-03-20 15:34:21 -07:00
Milan Burda
a82bbd010e
build: strip trailing whitespace in docs ( #17488 )
2019-03-20 13:12:47 -07:00