electron/docs
nibbleswap 590858a38d
docs: fix camelcase in menu example (#30341)
* docs: fix camelcase in menu example and add hint to deal with TS error

hideothers -> hideOthers (the TS compiler caught this)
The TypeScript compiler also did not like the pattern used to
switch between platforms for submenus was loosing the type information
of the literal constants and generalized them as strings which
conflicts with the type definition of MenuItemConstructorOptions.

* docs: Fix spelling, added hint to TypeScript

Without explicitly stating the type for the const template TypeScript does not create a
with the correct shape due to generalization to strings.

* remove ts hints

Co-authored-by: a <a@b>
Co-authored-by: Cheng Zhao <github@zcbenz.com>
2021-08-10 10:01:39 +09:00
..
api docs: fix camelcase in menu example (#30341) 2021-08-10 10:01:39 +09:00
development docs: update link to Chromium's coding style guide (#29330) 2021-05-27 19:07:46 -07:00
fiddles docs: modernize protocol-handler docs (#29380) 2021-07-08 11:42:28 -07:00
images docs: Update represented-file fiddle tutorial (#29245) 2021-06-15 10:29:51 +09:00
tutorial docs: update to the use of arrow functions in line with the style guide (#30194) 2021-08-02 10:57:37 +09:00
README.md docs: rework introduction docs (#29062) 2021-05-24 11:32:36 +09:00
breaking-changes.md docs: crashpad on linux lands in 16, not 15. (#30387) 2021-08-04 10:16:05 -07:00
experimental.md docs: document what experimental means explicitly (#22893) 2020-04-02 09:32:18 -07:00
faq.md docs: tidy up links (#26292) 2020-11-02 18:58:14 +09:00
glossary.md docs: tidy up links (#26292) 2020-11-02 18:58:14 +09:00
styleguide.md docs: update style guide (#29029) 2021-05-19 11:55:36 +09: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