electron/docs
Michaela Laurencin 41646d1168
feat: enable windows control overlay on Windows (#29600)
* rebase "feat: enable windows control overlay on Windows"

* correct compilation error

* fix linting errors

* modify includes and build file

* change `hidden` option to `overlay`

* add patch to fix visual layout

* add button background color parameter

* add button text color parameter

* modify `overlay` in docs and modify button hover/press transition color

* change `text` to `symbol`

* remove todo and fix `text` replacement

* add new titleBarOverlay property and remove titleBarStyle `overlay`

* update browser and frameless window docs

* remove chromium patches

* chore: update patches

* change button hover color, update trailing `_`, update test file

* add dchecks, update title bar drawing checks, update test file

* modify for mac and linux builds

* update docs with overlayColor and overlaySymbolColor

* add corner and side hit test info

* modify docs and copyright info

* modify `titlebar_overlay_` as boolean or object

* move `title_bar_style_ to `NativeWindow`

* update docs with boolean and object titlebar_overlay_

* add `IsEmpty` checks

* move get options for boolean and object checks

* fix linting error

* disable `use_lld` for macos

* Update docs/api/frameless-window.md

Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org>

* Update docs/api/frameless-window.md

Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org>

* Update docs/api/frameless-window.md

Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org>

* Apply docs suggestions from code review

Co-authored-by: Jeremy Rose <jeremya@chromium.org>

* modify `true` option description `titleBarOverlay`

* ci: cleanup keychain after tests on arm64 mac (#30472)

Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org>
Co-authored-by: PatchUp <73610968+patchup[bot]@users.noreply.github.com>
Co-authored-by: Jeremy Rose <jeremya@chromium.org>
2021-08-11 14:07:36 -04:00
..
api feat: enable windows control overlay on Windows (#29600) 2021-08-11 14:07:36 -04: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
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
README.md docs: rework introduction docs (#29062) 2021-05-24 11:32:36 +09:00
styleguide.md docs: update style guide (#29029) 2021-05-19 11:55:36 +09:00

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