electron/docs
trop[bot] 3764c4d0b3
docs: Make ipcRenderer and ipcMain listener API docs consistent (#44711)
* docs: Make ipcRenderer and ipcMain listener API docs consistent

Co-authored-by: Will Anderson <will@itsananderson.com>

* test: add some unit tests for ipcRenderer/ipcMain listener behavior

Co-authored-by: Will Anderson <will@itsananderson.com>

* fix: Mark on/off methods as primary and addListener/removeListener as aliases

Co-authored-by: Will Anderson <will@itsananderson.com>

* fix: clear all listeners before running ipcMain removeAllListeners tests

Co-authored-by: Will Anderson <will@itsananderson.com>

---------

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Will Anderson <will@itsananderson.com>
2024-11-19 09:47:45 +01:00
..
api docs: Make ipcRenderer and ipcMain listener API docs consistent (#44711) 2024-11-19 09:47:45 +01:00
development docs: document Windows pitfall when updating patches (#43787) 2024-09-19 23:35:21 -05:00
fiddles docs: add custom titlebar example (#44506) 2024-11-01 12:47:51 -05:00
images docs: add custom titlebar example (#44506) 2024-11-01 12:47:51 -05:00
tutorial docs: document why to use the loadBrowserProcessSpecificV8Snapshot fuse (#44709) 2024-11-18 17:51:10 -06:00
README.md docs: navigation history example (#42980) 2024-09-23 10:18:26 -07:00
api-history.schema.json docs: api history (#42982) 2024-08-19 11:17:10 -07:00
breaking-changes.md feat: add WebFrameMain detached property (#43473) 2024-10-11 18:33:53 -04:00
experimental.md docs: fix apostrophe typo "Electrons" -> "Electron's" (#44537) 2024-11-03 09:33:10 -06:00
faq.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
glossary.md docs: update docs.microsoft.com links to learn.microsoft.com (#37707) 2023-03-29 12:16:44 +02:00
styleguide.md docs: api history (#42982) 2024-08-19 11:17:10 -07:00

README.md

Official Guides

Please make sure that you use the documents that match your Electron version. The version number should be a part of the page URL. If it's not, you are probably using the documentation of a development branch which may contain API changes that are not compatible with your Electron version. To view older versions of the documentation, you can browse by tag on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag that matches your version.

FAQ

There are questions that are asked quite often. Check this out before creating an issue:

Guides and Tutorials

Getting started

Learning the basics

Advanced steps

Detailed Tutorials

These individual tutorials expand on topics discussed in the guide above.


API References

Custom DOM Elements:

Modules for the Main Process:

Modules for the Renderer Process (Web Page):

Modules for Both Processes:

Development

See development/README.md