docs: Update Quick Start Guide to work with contextIsolation #28229
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 tasks
With `contextIsolation` enabled by default in Electron 12, the Getting Started Guide no longer works as it is written. In order for the basic example to display values from `process.versions`, we need to add a `preload.js` to the example.
erickzhao
approved these changes
Mar 17, 2021
timching
reviewed
Mar 17, 2021
docs/tutorial/quick-start.md
Outdated
| createWindow() | ||
| } | ||
| }) | ||
| ) |
There was a problem hiding this comment.
Hi, just found that this line missed a } when I followed the quick start guide to build the hello world app.
And it seems that only this PR is still missing the }.
Member
Author
There was a problem hiding this comment.
Thank you for pointing this out! I've sent #28253 to fix the issue in the master branch, and I'll also push updates for this PR
zcbenz
approved these changes
Mar 18, 2021
|
No Release Notes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Manual backport of #28223 to 13-x-y
Description of Change
With
contextIsolationenabled by default in Electron 12, the Getting Started Guide no longer works as it is written. In order for the basic example to display values fromprocess.versions, this change adds apreload.jsto the example.Adding a preload script does increase the complexity of the "hello world" example, but setting
contextIsolation: falsein the example code seemed like a less ideal solution since it encourages insecure practicesChecklist
Release Notes
Notes: no-notes