The Wayback Machine - https://web.archive.org/web/20211031182341/https://github.com/electron/electron/pull/31054
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add window customization guide #31054

Merged
merged 17 commits into from Oct 19, 2021

Conversation

Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
@erickzhao
Copy link
Member

@erickzhao erickzhao commented Sep 21, 2021

Description of Change

Renames the Frameless Window doc to better reflect what it does and moves the page from /api/ to /tutorial/.

Also restructures the entire guide to hopefully be clearer and removes old outdated information that was left over after refactors.

cc @mlaurencin @jkleinsc

Checklist

Release Notes

Notes: none

Copy link
Member

@malept malept left a comment

👍 for moving this out of the API docs

docs/tutorial/offscreen-rendering.md Outdated Show resolved Hide resolved
@@ -0,0 +1,266 @@
# Window Customization

The `BrowserWindow` module is the foundation of your Electron application, and it exposes
Copy link
Member

@malept malept Sep 21, 2021

Nit

Suggested change
The `BrowserWindow` module is the foundation of your Electron application, and it exposes
The `BrowserWindow` module is the foundation of your Electron application, and exposes

docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Show resolved Hide resolved
@erickzhao erickzhao force-pushed the docs/frameless-window-tutorial branch from 6a85202 to c233e3c Sep 23, 2021
@jkleinsc jkleinsc requested a review from malept Sep 27, 2021
Copy link
Contributor

@jkleinsc jkleinsc left a comment

LGTM... just missing a description

docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/api/browser-window.md Outdated Show resolved Hide resolved
docs/api/browser-window.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
docs/tutorial/window-customization.md Outdated Show resolved Hide resolved
erickzhao and others added 15 commits Oct 2, 2021
@erickzhao erickzhao requested a review from malept Oct 2, 2021
@zcbenz zcbenz merged commit c3a8ad2 into electron:main Oct 19, 2021
13 checks passed
@release-clerk
Copy link

@release-clerk release-clerk bot commented Oct 19, 2021

No Release Notes

@trop
Copy link
Contributor

@trop trop bot commented Oct 19, 2021

I was unable to backport this PR to "15-x-y" cleanly;
you will need to perform this backport manually.

@trop trop bot removed the target/15-x-y label Oct 19, 2021
@trop
Copy link
Contributor

@trop trop bot commented Oct 19, 2021

I was unable to backport this PR to "16-x-y" cleanly;
you will need to perform this backport manually.

erickzhao added a commit to erickzhao/electron that referenced this issue Oct 20, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>
@trop
Copy link
Contributor

@trop trop bot commented Oct 20, 2021

@erickzhao has manually backported this PR to "15-x-y", please check out #31507

erickzhao added a commit to erickzhao/electron that referenced this issue Oct 20, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>
@trop
Copy link
Contributor

@trop trop bot commented Oct 20, 2021

@erickzhao has manually backported this PR to "16-x-y", please check out #31508

jkleinsc pushed a commit that referenced this issue Oct 21, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>

Co-authored-by: Mark Lee <[email protected]>
zcbenz pushed a commit that referenced this issue Oct 22, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>

Co-authored-by: Mark Lee <[email protected]>
t57ser added a commit to t57ser/electron that referenced this issue Oct 27, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>
t57ser added a commit to t57ser/electron that referenced this issue Oct 27, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>
t57ser added a commit to t57ser/electron that referenced this issue Oct 29, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>
t57ser added a commit to t57ser/electron that referenced this issue Oct 29, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>
t57ser added a commit to t57ser/electron that referenced this issue Oct 29, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>
t57ser added a commit to t57ser/electron that referenced this issue Oct 29, 2021
* docs: add window customization guide

* fixes

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/api/browser-window.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/fiddles/windows/manage-windows/frameless-window/index.html

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* Update docs/tutorial/window-customization.md

Co-authored-by: Mark Lee <[email protected]>

* fix code fence

Co-authored-by: Mark Lee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment