Piotr Płaczek
4d51edc504
docs: api history ( #42982 )
...
* feat(api-history): api history schema
Reference: f36e0a8483/text/0004-api-history-schema.mdhttps://github.com/electron/electron/pull/42982/files#r1692532877
* docs(api-history): schema word choice
Co-authored-by: Erick Zhao <erick@hotmail.ca>
Reference: 0b1b6a7cc0https://github.com/electron/electron/pull/42982#discussion_r1692539906
* docs(api-history): Always use double quotes for descriptions
* docs(api-history): `styleguide.md` improvements
* docs(api-history): copy `ipc-renderer.md` change to `context-bridge.md`
* docs(api-history): `styleguide.md` placement
* docs(api-history): add migration guide
* docs(api-history): remove confusing `breaking-changes-header` in `browser-view.md`
Reference: 7b03c0703d (r1703444772)https://github.com/electron/electron/pull/42982#discussion_r1703441001
* docs(api-history): update `breaking-changer-header`
Reference: https://github.com/electron/electron/pull/43217
* docs(api-history): deprecate `browser-view.md`
---------
Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
2024-08-19 11:17:10 -07:00
Erick Zhao
09fb892c6e
docs: ensure all links are on a single line ( #42235 )
2024-05-28 11:15:18 -07:00
David Sanders
3d2a754531
chore: extend linting of code blocks in the docs ( #40245 )
...
* chore: extend linting of code blocks in the docs
* chore: combine lint:markdownlint and lint:markdown scripts
2023-11-21 16:50:08 +09:00
Milan Burda
9c7086074e
docs: add missing ipcRenderer.off() / ipcRenderer.addListener() aliases ( #39816 )
...
* docs: add missing `ipcRenderer.off()` / `ipcRenderer.addListener()` aliases
* Update docs/api/ipc-renderer.md
Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
* fix ipcRenderer.removeListener
* update ts-smoke
---------
Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
2023-09-19 01:58:20 +09:00
Milan Burda
5078cae861
chore: remove deprecated ipcRenderer.sendTo() ( #39087 )
...
chore: remove deprecated ipcRenderer.sendTo()
2023-08-28 10:29:27 -04:00
Milan Burda
ada8eb33b2
feat: deprecate ipcRenderer.sendTo() ( #39091 )
...
* feat: deprecate ipcRenderer.sendTo()
* docs: add _Deprecated_ to ipcRenderer.sendTo()
2023-07-21 11:16:44 +02:00
David Sanders
3a5e2dd90c
docs: remove redundant IPC event sections ( #39133 )
...
* docs: use correct names for IPC events
* docs: remove redundant IPC event sections
2023-07-20 11:43:08 -07:00
David Sanders
905aad9cb6
chore: type check JS in docs ( #38423 )
...
* build(deps): update @electron/lint-roller
* chore: type check JS in docs
* docs: add @ts-check and @ts-expect-error to code blocks
* chore: fix type check errors in docs
* chore: add ts-type to blocks
2023-06-05 16:26:26 +09:00
David Sanders
d94f35a8f6
chore: disallow shortcut reference links in docs Markdown ( #36860 )
...
* chore: disallow shortcut reference links in docs Markdown
* docs: clean up shortcut-style links
2023-01-16 10:22:49 +01:00
Jeremy Rose
a75e8e051e
docs: document that when invoke rejects, it gives a different Error ( #36127 )
2022-10-26 13:56:41 -07:00
Erick Zhao
e9a43be9be
docs: add IPC doc ( #32059 )
...
* docs: add IPC doc
* fix: use "string" primitive
* use 'string' ipcrenderer
* use "number" primitive
* Update docs/tutorial/ipc.md
Co-authored-by: Jeremy Rose <nornagon@nornagon.net>
* Update docs/tutorial/ipc.md
Co-authored-by: Jeremy Rose <nornagon@nornagon.net>
* add code sample
Co-authored-by: Jeremy Rose <nornagon@nornagon.net>
2022-02-09 11:00:05 -05:00
Milan Burda
e6b1d95a1c
docs: type names changed from wrapper to primitive ( #31752 )
2021-11-15 22:13:18 -06:00
Erick Zhao
78d4cb9f5c
docs: update verb tenses for structured clone notes ( #27483 )
2021-01-26 14:14:44 -08:00
Jeremy Rose
040ee66678
docs: note about structured clone and DOM types ( #26516 )
2020-11-17 11:11:40 -08:00
David Sanders
43dbd1bdf8
chore: cleanup whitespace in docs ( #26356 )
2020-11-05 14:12:43 -08:00
GitHubPang
47f88b65b7
docs: fix typo in api/ipc-renderer ( #24901 )
2020-08-11 07:31:38 -07:00
Jeremy Apthorp
b4d07f76d3
feat: MessagePorts in the main process ( #22404 )
2020-03-11 18:07:54 -07:00
Jeremy Apthorp
2fad53e66b
refactor: use v8 serialization for ipc ( #20214 )
...
* refactor: use v8 serialization for ipc
* cloning process.env doesn't work
* serialize host objects by enumerating key/values
* new serialization can handle NaN, Infinity, and undefined correctly
* can't allocate v8 objects during GC
* backport microtasks fix
* fix compile
* fix node_stream_loader reentrancy
* update subframe spec to expect undefined instead of null
* write undefined instead of crashing when serializing host objects
* fix webview spec
* fix download spec
* buffers are transformed into uint8arrays
* can't serialize promises
* fix chrome.i18n.getMessage
* fix devtools tests
* fix zoom test
* fix debug build
* fix lint
* update ipcRenderer tests
* fix printToPDF test
* update patch
* remove accidentally re-added remote-side spec
* wip
* don't attempt to serialize host objects
* jump through different hoops to set options.webContents sometimes
* whoops
* fix lint
* clean up error-handling logic
* fix memory leak
* fix lint
* convert host objects using old base::Value serialization
* fix lint more
* fall back to base::Value-based serialization
* remove commented-out code
* add docs to breaking-changes.md
* Update breaking-changes.md
* update ipcRenderer and WebContents docs
* lint
* use named values for format tag
* save a memcpy for ~30% speedup
* get rid of calls to ShallowClone
* extra debugging for paranoia
* d'oh, use the correct named tags
* apparently msstl doesn't like this DCHECK
* funny story about that DCHECK
* disable remote-related functions when enable_remote_module = false
* nits
* use EnableIf to disable remote methods in mojom
* fix include
* review comments
2019-10-09 13:59:08 -04:00
Shelley Vohr
3395a1d4db
doc: improve EventEmitter md formatting ( #19345 )
2019-07-22 08:20:43 -07:00
Samuel Attard
f80601da16
docs: ensure that optionality matches between documented params and signatures ( #18613 )
...
* docs: ensure that optionality matches between documented params and signatures
* docs: ensure that all optional declarations are lower case
* chore: fix broken link
2019-06-04 14:03:24 -07:00
Jeremy Apthorp
c436997840
feat: add ipcRenderer.invoke() ( #18449 )
2019-05-31 10:25:19 -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
Samuel Attard
3b74837020
refactor: Split 'Event' docs/types into more specific Event types ( #17038 )
...
* Event = Base event type (with preventDefault)
* IpcMainEvent = Event that ipcMain emits (with sender, reply, etc.)
* IpcRendererEvent = Event that ipcRenderer emits (with sender,
senderId, etc.)
* KeyboardEvent = Event that we emit with keyboard flags (ctrlKey,
altKey, etc.)
This will dramatically improve peoples TS experience with IPC events
2019-02-19 09:24:19 +00:00
Shelley Vohr
7a03e5f0b2
doc: correct ipcRenderer sendTo windowId param ( #15403 )
2018-10-26 10:18:47 -05:00
Milan Burda
c17a1b37ea
feat: add event.senderId property to IPCs sent via ipcRenderer.sendTo ( #14395 )
2018-08-31 20:13:51 -05:00
Toinane
3d4ef66775
add some markdown links
2017-11-29 12:13:45 +01:00
Toinane
0a0d88a5dc
remove all double spaces not needed
2017-11-29 11:58:24 +01:00
Toinane
323ea2b27b
fix(docs): fix all missing dots and add some links
2017-11-29 11:38:35 +01:00
73mp74710n
0a0897ef28
Update ipc-renderer.md
2017-10-18 02:52:02 +01:00
73mp74710n
c647b0c65e
update docs to show usage of ipcRenderer.sendTo
2017-10-18 02:35:19 +01:00
Samuel Attard
e58ba1dc8e
Update ipc-renderer.md
2017-08-29 16:12:55 +10:00
Zeke Sikelianos
f646be2981
document the return value of ipcRenderer.sendSync
2017-06-27 12:01:39 -07:00
Zeke Sikelianos
e57cb713b2
link process annotations to glossary
2016-12-21 13:47:40 -08:00
Samuel Attard
63ebc41778
More docs updates
2016-11-11 09:22:55 -08:00
Zeke Sikelianos
ef9d8fe9bd
Merge pull request #7843 from electron/process-docs
...
document the process(es) in which APIs are available
2016-11-03 13:14:30 -07:00
Zeke Sikelianos
ac68de6215
document process(es) for all APIs
2016-11-03 10:26:00 -07:00
Samuel Attard
6228ce3f35
Fix the IPC docs so the docs-linter finds the methods
2016-11-03 14:04:03 +11: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
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
Plusb Preco
546ad643e4
📝 Add missing docs
...
[ci skip]
2016-03-31 14:30:14 +09:00
Cheng Zhao
b8e8e4c930
docs: Cleanup the IPC docs
2016-02-16 11:34:39 +08:00
Luke Page
2c6e5d0464
Clarify arguments sent via ipc
2016-02-15 06:29:52 +01:00
Mark Potnick
b9e2806042
Fixing typo
2016-02-03 15:15:13 -05:00
Ming Luo
ad9c254730
Styled the removeListener & removeAllListeners
...
They were previously not written with the same style as other parts of
the doc. Also there was a couple grammar errors
2016-01-14 09:27:24 -05:00
Ming Luo
a82ecfda06
Detail ipc.removeListener & ipc.removeAllListeners
2016-01-13 10:18:12 -05:00
Eran Tiktin
b7ae9d3337
Update ipc-renderer.md
...
Removed duplication.
2015-11-19 02:11:32 +02:00
Cheng Zhao
90a7d4a906
docs: Update with new IPC modules
2015-11-10 16:48:24 +08:00
Jessica Lord
279fd0a461
Standardize **Note:**
2015-09-09 14:09:14 -07:00
Jessica Lord
8ee91bce44
message → arg
2015-08-28 14:57:14 -07:00
